Cleanup api3 docblocks

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

diff --git a/api/v3/Email.php b/api/v3/Email.php
index d288afef47f3f9536f50d61f83cff0588d8f519a..c47b6a069450cec1635f2f29fe269c3bb3ec10c0 100644 (file)
--- a/api/v3/Email.php
+++ b/api/v3/Email.php
@@ -26,23 +26,18 @@
  */
 
 /**
- * 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
@@ -52,9 +47,10 @@ function civicrm_api3_email_create($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.
  */
@@ -66,24 +62,23 @@ 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 bool
- *   | error  true if successfull, error otherwise
+ * @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
+ * Retrieve one or more emails.
  *
  * @param array $params
- *   An associative array of name/value pairs.
+ *   Array per getfields metadata.
  *
  * @return array
  *   api result array