Cleanup api3 docblocks

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

diff --git a/api/v3/Email.php b/api/v3/Email.php
index 288c4981f93dab243d1064bb7b259f5bf084449d..c47b6a069450cec1635f2f29fe269c3bb3ec10c0 100644 (file)
--- a/api/v3/Email.php
+++ b/api/v3/Email.php
@@ -23,39 +23,34 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
- * File for the CiviCRM APIv3 email functions
+ * This api exposes CiviCRM email.
  *
  * @package CiviCRM_APIv3
  * @subpackage API_Email
  *
- * @copyright CiviCRM LLC (c) 2004-2014
- * @version $Id: Email.php 2011-02-16 ErikHommel $
  */
 
 /**
- * Add an Email for a contact
- *
- * Allowed @params array keys are:
- *
- * @example EmailCreate.php Standard Create Example
+ * Add an Email for a contact.
  *
  * @param array $params
+ *   Array per getfields metadata.
  *
  * @return array
  *   API result array
- * {@getfields email_create}
  */
 function civicrm_api3_email_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
 /**
- * Adjust Metadata for Create action
+ * Adjust Metadata for Create action.
+ *
+ * The metadata is used for setting defaults, documentation & validation.
  *
- * The metadata is used for setting defaults, documentation & validation
  * @param array $params
  *   Array or parameters determined by getfields.
  */
@@ -67,34 +62,26 @@ function _civicrm_api3_email_create_spec(&$params) {
 }
 
 /**
- * Deletes an existing Email
+ * Deletes an existing Email.
  *
  * @param array $params
+ *   Array per getfields metadata.
  *
- * @example EmailDelete.php Standard Delete Example
- *
- * @return boolean
- *   | error  true if successfull, error otherwise
- * {@getfields email_delete}
+ * @return array
+ *   API result array.
  */
 function civicrm_api3_email_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
 /**
- * Retrieve one or more emails
- *
- * @param array input parameters
- *
- *
- * @example EmailGet.php Standard Get Example
+ * Retrieve one or more emails.
  *
  * @param array $params
- *   An associative array of name/value pairs.
+ *   Array per getfields metadata.
  *
  * @return array
  *   api result array
- * {@getfields email_get}
  */
 function civicrm_api3_email_get($params) {