From decce855d7cc6a04e476d4effe450f70669e6c62 Mon Sep 17 00:00:00 2001
From: Eileen McNaughton <eileen@fuzion.co.nz>
Date: Tue, 13 Jan 2015 13:44:19 +1300
Subject: [PATCH] minor comment corrections

---
 api/class.api.php           | 2 +-
 api/v3/Constant.php         | 3 ++-
 api/v3/CustomGroup.php      | 6 ++----
 api/v3/Entity.php           | 2 +-
 api/v3/MembershipStatus.php | 5 +----
 5 files changed, 7 insertions(+), 11 deletions(-)

diff --git a/api/class.api.php b/api/class.api.php
index 8b2c2145ee..f2350ccba0 100644
--- a/api/class.api.php
+++ b/api/class.api.php
@@ -79,7 +79,7 @@
 class civicrm_api3 {
 
   /**
-   * @param array API configuration.
+   * @param array $config API configuration.
    */
   function __construct($config = NULL) {
     $this->local      = TRUE;
diff --git a/api/v3/Constant.php b/api/v3/Constant.php
index e0573f6c40..ed59163a7b 100644
--- a/api/v3/Constant.php
+++ b/api/v3/Constant.php
@@ -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>
diff --git a/api/v3/CustomGroup.php b/api/v3/CustomGroup.php
index ebfa6901c6..3043981451 100644
--- a/api/v3/CustomGroup.php
+++ b/api/v3/CustomGroup.php
@@ -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);
diff --git a/api/v3/Entity.php b/api/v3/Entity.php
index 10234aabab..52ce682a1a 100644
--- a/api/v3/Entity.php
+++ b/api/v3/Entity.php
@@ -2,7 +2,7 @@
 
 /**
  * @deprecated api notice
- * @param array entities
+ * @param array $entities
  * @return array
  *   Array of deprecated api entities
  */
diff --git a/api/v3/MembershipStatus.php b/api/v3/MembershipStatus.php
index 10aaa8c28c..da355eef6c 100644
--- a/api/v3/MembershipStatus.php
+++ b/api/v3/MembershipStatus.php
@@ -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) {
 
-- 
2.25.1