minor comment corrections
authorEileen McNaughton <eileen@fuzion.co.nz>
Tue, 13 Jan 2015 00:44:19 +0000 (13:44 +1300)
committerEileen McNaughton <eileen@fuzion.co.nz>
Tue, 13 Jan 2015 00:44:19 +0000 (13:44 +1300)
api/class.api.php
api/v3/Constant.php
api/v3/CustomGroup.php
api/v3/Entity.php
api/v3/MembershipStatus.php

index 8b2c2145ee00b7b2183e25320c4d8cf6aa1a7618..f2350ccba0da87a0ba0643970356f389c40fdc12 100644 (file)
@@ -79,7 +79,7 @@
 class civicrm_api3 {
 
   /**
-   * @param array API configuration.
+   * @param array $config API configuration.
    */
   function __construct($config = NULL) {
     $this->local      = TRUE;
index e0573f6c40b0bf1f631a337454388885dad8ca2c..ed59163a7bbd53f3ba7f3bcd724e9f52efa343a8 100644 (file)
@@ -48,7 +48,8 @@ function _civicrm_api3_constant_deprecation() {
  * @deprecated as of CiviCRM 4.4.
  * It's recommended to use the api getoptions action instead
  *
- * @param  string  Name of a public static method of
+ * @param array $params
+ *  Name of a public static method of
  *                  CRM_Core_PseudoConstant: one of
  *  <ul>
  *    <li>activityStatus</li>
index ebfa6901c64129ea056e03e2d40170b1f838cba9..30439814519cabcf1d4368155bfe6d6eb4d542c0 100644 (file)
@@ -95,13 +95,11 @@ function _civicrm_api3_custom_group_create_spec(&$params) {
 /**
  * Use this API to delete an existing group.
  *
- * @param array id of the group to be deleted
+ * @param array $params
  *
- * @return Null
- *   if success
+ * @return array
  */
 function civicrm_api3_custom_group_delete($params) {
-
   $values = new CRM_Core_DAO_CustomGroup();
   $values->id = $params['id'];
   $values->find(TRUE);
index 10234aababcb9289e32e3c2db4af2ff93179ccd3..52ce682a1aa02af3a7c7bce210b51b253816cd1b 100644 (file)
@@ -2,7 +2,7 @@
 
 /**
  * @deprecated api notice
- * @param array entities
+ * @param array $entities
  * @return array
  *   Array of deprecated api entities
  */
index 10aaa8c28cee53632aef20b0744895b74eb574ce..da355eef6c3e0ce9d69b5d964e7cb4f52034677d 100644 (file)
@@ -116,11 +116,8 @@ function &civicrm_api3_membership_status_update($params) {
  *
  * This API is used for deleting a membership status
  *
- * @param array Params array containing 'id' - Id of the membership status to be deleted
- * {@getfields MembershipStatus_delete}
- *
+ * @param array $params
  * @return array
- *   i
  */
 function civicrm_api3_membership_status_delete($params) {