From: Coleman Watts <coleman@civicrm.org>
Date: Fri, 23 Jan 2015 14:29:33 +0000 (-0500)
Subject: Comment cleanup
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=8c6b335bca88b0e84dd00dc3b8425bbe71b3d974;p=civicrm-core.git

Comment cleanup
---

diff --git a/api/v3/Activity.php b/api/v3/Activity.php
index c4a95986e8..9ebad65d5a 100644
--- a/api/v3/Activity.php
+++ b/api/v3/Activity.php
@@ -470,10 +470,8 @@ function _civicrm_api3_activity_getlist_params(&$request) {
 /**
  * @see _civicrm_api3_generic_getlist_output
  *
- * @param $result
- *   Array.
- * @param $request
- *   Array.
+ * @param array $result
+ * @param array $request
  *
  * @return array
  */
diff --git a/api/v3/Contact.php b/api/v3/Contact.php
index fed2bca617..94c77d2b83 100644
--- a/api/v3/Contact.php
+++ b/api/v3/Contact.php
@@ -946,8 +946,7 @@ WHERE     $whereClause
 /**
  * @see _civicrm_api3_generic_getlist_params
  *
- * @param $request
- *   Array.
+ * @param array $request
  */
 function _civicrm_api3_contact_getlist_params(&$request) {
   // get the autocomplete options from settings
@@ -990,10 +989,8 @@ function _civicrm_api3_contact_getlist_params(&$request) {
 /**
  * @see _civicrm_api3_generic_getlist_output
  *
- * @param $result
- *   Array.
- * @param $request
- *   Array.
+ * @param array $result
+ * @param array $request
  *
  * @return array
  */
diff --git a/api/v3/Event.php b/api/v3/Event.php
index cc4f08fe10..55cd7fe51f 100644
--- a/api/v3/Event.php
+++ b/api/v3/Event.php
@@ -220,8 +220,7 @@ function _civicrm_api3_event_getisfull(&$event, $event_id) {
 /**
  * @see _civicrm_api3_generic_getlist_params
  *
- * @param $request
- *   Array.
+ * @param array $request
  */
 function _civicrm_api3_event_getlist_params(&$request) {
   $fieldsToReturn = array('start_date', 'event_type_id', 'title', 'summary');
@@ -236,10 +235,8 @@ function _civicrm_api3_event_getlist_params(&$request) {
 /**
  * @see _civicrm_api3_generic_getlist_output
  *
- * @param $result
- *   Array.
- * @param $request
- *   Array.
+ * @param array $result
+ * @param array $request
  *
  * @return array
  */
diff --git a/api/v3/Generic/Getlist.php b/api/v3/Generic/Getlist.php
index aee2a58c13..5af1f8de61 100644
--- a/api/v3/Generic/Getlist.php
+++ b/api/v3/Generic/Getlist.php
@@ -28,7 +28,6 @@
  * Generic api wrapper used for quicksearch and autocomplete
  *
  * @param array $apiRequest
- *   Array.
  * @return mixed
  */
 function civicrm_api3_generic_getList($apiRequest) {
@@ -66,10 +65,8 @@ function civicrm_api3_generic_getList($apiRequest) {
 /**
  * Set defaults for api.getlist
  *
- * @param $entity
- *   String.
- * @param $request
- *   Array.
+ * @param string $entity
+ * @param array $request
  */
 function _civicrm_api3_generic_getList_defaults($entity, &$request) {
   $config = CRM_Core_Config::singleton();
@@ -129,8 +126,7 @@ function _civicrm_api3_generic_getList_defaults($entity, &$request) {
 /**
  * Fallback implementation of getlist_params. May be overridden by individual apis
  *
- * @param $request
- *   Array.
+ * @param array $request
  */
 function _civicrm_api3_generic_getlist_params(&$request) {
   $fieldsToReturn = array($request['id_field'], $request['label_field']);
@@ -146,10 +142,8 @@ function _civicrm_api3_generic_getlist_params(&$request) {
 /**
  * Fallback implementation of getlist_output. May be overridden by individual apis
  *
- * @param $result
- *   Array.
- * @param $request
- *   Array.
+ * @param array $result
+ * @param array $request
  *
  * @return array
  */