INFRA-132 - Fix comment spacing
[civicrm-core.git] / api / v3 / Email.php
index d40582d96d724c211a65d3ff567889b1bcb13d72..017c2a1d2705b553536e3e78a602316f85d86700 100644 (file)
@@ -2,7 +2,7 @@
 
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -43,6 +43,8 @@
  *
  * @example EmailCreate.php Standard Create Example
  *
+ * @param array $params
+ *
  * @return array API result array
  * {@getfields email_create}
  * @access public
@@ -55,7 +57,8 @@ function civicrm_api3_email_create($params) {
  * Adjust Metadata for Create action
  *
  * The metadata is used for setting defaults, documentation & validation
- * @param array $params array or parameters determined by getfields
+ * @param array $params
+ *   Array or parameters determined by getfields.
  */
 function _civicrm_api3_email_create_spec(&$params) {
   // TODO a 'clever' default should be introduced
@@ -67,7 +70,7 @@ function _civicrm_api3_email_create_spec(&$params) {
 /**
  * Deletes an existing Email
  *
- * @param  array  $params
+ * @param array $params
  *
  * @example EmailDelete.php Standard Delete Example
  *
@@ -82,14 +85,15 @@ function civicrm_api3_email_delete($params) {
 /**
  * Retrieve one or more emails
  *
- * @param  array input parameters
+ * @param array input parameters
  *
  *
  * @example EmailGet.php Standard Get Example
  *
- * @param  array $params  an associative array of name/value pairs.
+ * @param array $params
+ *   An associative array of name/value pairs.
  *
- * @return  array api result array
+ * @return array api result array
  * {@getfields email_get}
  * @access public
  */
@@ -97,4 +101,3 @@ function civicrm_api3_email_get($params) {
 
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
-