CRM-15988 - Mass cleanup of api entity names to CamelCase
[civicrm-core.git] / api / v3 / MailSettings.php
index 88f39c1e74c325020525ef78995261cbb8180a47..686e9acb23fb9d559286d6cf966e11ec66cdc5cd 100644 (file)
  * This api exposes CiviCRM mail settings.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_mail_settings
  */
 
 /**
- * Create or update a mail_settings.
+ * Create or update a MailSettings.
  *
  * @param array $params
- *   name/value pairs to insert in new 'mail_settings'
+ *   name/value pairs to insert in new 'MailSettings'
  *
  * @return array
  *   API result array.
@@ -51,18 +50,17 @@ 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 property_name=>value pairs.
- *   If $params is set as null, all mail_settings will be returned
+ *   If $params is set as null, all MailSettings will be returned.
  *
  * @return array
  *   API result array.
@@ -72,7 +70,7 @@ function civicrm_api3_mail_settings_get($params) {
 }
 
 /**
- * Delete an existing mail_settings.
+ * Delete an existing MailSettings.
  *
  * @param array $params
  *   [id]