Merge pull request #6356 from monishdeb/CRM-16931

[civicrm-core.git] / api / v3 / MailSettings.php

diff --git a/api/v3/MailSettings.php b/api/v3/MailSettings.php
index b4b2d1784a06ee6b09dc4572699bc39b34e24959..df9707e098faf79e4bd3f33c358e8f69dd96c117 100644 (file)
--- a/api/v3/MailSettings.php
+++ b/api/v3/MailSettings.php
@@ -3,7 +3,7 @@
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -26,24 +26,19 @@
  */
 
 /**
- * File for the CiviCRM APIv3 group functions
+ * This api exposes CiviCRM mail settings.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_mail_settings
- * @copyright CiviCRM LLC (c) 2004-2014
  */
 
 /**
- * Create or update a mail_settings
+ * Create or update a MailSettings.
  *
  * @param array $params
- *   Associative array of property.
- *                       name/value pairs to insert in new 'mail_settings'
- * @example mail_settingsCreate.php Std Create example
+ *   name/value pairs to insert in new 'MailSettings'
  *
  * @return array
- *   api result array
- *   {@getfields mail_settings_create}
+ *   API result array.
  */
 function civicrm_api3_mail_settings_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -55,41 +50,33 @@ function civicrm_api3_mail_settings_create($params) {
  * The metadata is used for setting defaults, documentation & validation.
  *
  * @param array $params
- *   Array or parameters determined by getfields.
+ *   Array of parameters determined by getfields.
  */
 function _civicrm_api3_mail_settings_create_spec(&$params) {
-
 }
 
 /**
- * Returns array of mail_settings  matching a set of one or more group properties
+ * Returns array of MailSettings matching a set of one or more properties.
  *
  * @param array $params
- *   Array of one or more valid.
- *                       property_name=>value pairs. If $params is set
- *                       as null, all mail_settings will be returned
+ *   Array of one or more property_name=>value pairs.
+ *   If $params is set as null, all MailSettings will be returned.
  *
  * @return array
- *   Array of matching mail_settings
- *   {@getfields mail_settings_get}
+ *   API result array.
  */
 function civicrm_api3_mail_settings_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
 /**
- * delete an existing mail_settings
- *
- * This method is used to delete any existing mail_settings. id of the group
- * to be deleted is required field in $params array
+ * Delete an existing MailSettings.
  *
  * @param array $params
- *   Array containing id of the group.
- *                       to be deleted
+ *   [id]
  *
  * @return array
- *   api result array
- *   {@getfields mail_settings_delete}
+ *   API result array.
  */
 function civicrm_api3_mail_settings_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);