From c1a920f11afb16cce1e45e37bd6dcdc447cb778d Mon Sep 17 00:00:00 2001
From: Eileen McNaughton <eileen@fuzion.co.nz>
Date: Mon, 2 Feb 2015 16:38:15 +1300
Subject: [PATCH 1/1] A few comment fixes

---
 api/v3/Case.php             |  3 +--
 api/v3/Generic/Getlist.php  |  2 +-
 api/v3/Generic/Setvalue.php |  6 +++++-
 api/v3/Im.php               |  5 ++---
 api/v3/Job.php              | 31 ++++++++++++++++---------------
 5 files changed, 25 insertions(+), 22 deletions(-)

diff --git a/api/v3/Case.php b/api/v3/Case.php
index 870e8dc525..7eb05485c1 100644
--- a/api/v3/Case.php
+++ b/api/v3/Case.php
@@ -167,7 +167,7 @@ function _civicrm_api3_case_update_spec(&$params) {
 }
 
 /**
- * Adjust Metadata for Delete action
+ * Adjust Metadata for Delete action.
  *
  * @param array $params
  *   Array or parameters determined by getfields.
@@ -302,7 +302,6 @@ function _civicrm_api3_case_deprecation() {
  * @throws API_Exception
  * @return array
  *   api result array
- *
  */
 function civicrm_api3_case_update($params) {
   //check parameters
diff --git a/api/v3/Generic/Getlist.php b/api/v3/Generic/Getlist.php
index 86b8a653cd..3b2c8b6867 100644
--- a/api/v3/Generic/Getlist.php
+++ b/api/v3/Generic/Getlist.php
@@ -129,7 +129,7 @@ function _civicrm_api3_generic_getList_defaults($entity, &$request, $apiDefaults
 }
 
 /**
- * Fallback implementation of getlist_params. May be overridden by individual apis
+ * Fallback implementation of getlist_params. May be overridden by individual apis.
  *
  * @param array $request
  */
diff --git a/api/v3/Generic/Setvalue.php b/api/v3/Generic/Setvalue.php
index 2da98756fc..bf62d00bd1 100644
--- a/api/v3/Generic/Setvalue.php
+++ b/api/v3/Generic/Setvalue.php
@@ -26,7 +26,11 @@ function civicrm_api3_generic_setValue($apiRequest) {
   $field = CRM_Utils_String::munge($params['field']);
   $value = $params['value'];
 
-  $fields = civicrm_api($entity, 'getFields', array('version' => 3, 'action' => 'create', "sequential"));
+  $fields = civicrm_api($entity, 'getFields', array(
+    'version' => 3,
+    'action' => 'create',
+    "sequential")
+  );
   // getfields error, shouldn't happen.
   if ($fields['is_error']) {
     return $fields;
diff --git a/api/v3/Im.php b/api/v3/Im.php
index 448b337481..cf564f91f9 100644
--- a/api/v3/Im.php
+++ b/api/v3/Im.php
@@ -35,7 +35,7 @@
  */
 
 /**
- *  Add an IM for a contact.
+ * Add an IM for a contact.
  *
  * @param array $params
  *
@@ -71,14 +71,13 @@ function civicrm_api3_im_delete($params) {
 }
 
 /**
- * Retrieve one or more IM
+ * Retrieve one or more IM.
  *
  * @param array $params
  *   An associative array of name/value pairs.
  *
  * @return array
  *   details of found IM
- *
  */
 function civicrm_api3_im_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
diff --git a/api/v3/Job.php b/api/v3/Job.php
index 65436f8d48..29786ff4e5 100644
--- a/api/v3/Job.php
+++ b/api/v3/Job.php
@@ -35,13 +35,13 @@
  * @subpackage API_Job
  * @copyright CiviCRM LLC (c) 2004-2014
  * $Id: Contact.php 30879 2010-11-22 15:45:55Z shot $
- *
  */
 
 /**
- * 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.
  */
@@ -56,14 +56,12 @@ function _civicrm_api3_job_create_spec(&$params) {
 }
 
 /**
- * create scheduled job
+ * Create scheduled job.
  *
  * @param array $params
  *   Associative array of property name/value pairs to insert in new job.
  *
  * @return array
- *
- *   {@getfields Job_create}
  */
 function civicrm_api3_job_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -145,7 +143,7 @@ function civicrm_api3_job_geocode($params) {
 }
 
 /**
- * First check on Code documentation
+ * First check on Code documentation.
  *
  * @param array $params
  */
@@ -158,7 +156,7 @@ function _civicrm_api3_job_geocode_spec(&$params) {
 }
 
 /**
- * Send the scheduled reminders for all contacts (either for activities or events)
+ * Send the scheduled reminders for all contacts (either for activities or events).
  *
  * @param array $params
  *   (reference ) input parameters.
@@ -189,9 +187,10 @@ function civicrm_api3_job_send_reminder($params) {
   }
 }
 /**
- * Adjust metadata for "send_reminder" action
+ * Adjust metadata for "send_reminder" 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.
  */
@@ -204,7 +203,7 @@ function _civicrm_api3_job_send_reminder(&$params) {
   );
 }
 /**
- * Execute a specific report instance and send the output via email
+ * Execute a specific report instance and send the output via email.
  *
  * @param array $params
  *   (reference ) input parameters.
@@ -259,7 +258,8 @@ function civicrm_api3_job_update_greeting($params) {
 /**
  * Adjust Metadata for Get 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.
  */
@@ -277,9 +277,10 @@ function _civicrm_api3_job_update_greeting_spec(&$params) {
 }
 
 /**
- * Mass update pledge statuses
+ * Mass update pledge statuses.
  *
  * @param array $params
+ *
  * @return array
  */
 function civicrm_api3_job_process_pledge($params) {
@@ -297,7 +298,7 @@ function civicrm_api3_job_process_pledge($params) {
 }
 
 /**
- * Process mail queue
+ * Process mail queue.
  *
  * @param array $params
  *
@@ -332,7 +333,7 @@ function civicrm_api3_job_process_sms($params) {
 }
 
 /**
- * Job to get mail responses from civiMailing
+ * Job to get mail responses from civiMailing.
  *
  * @param array $params
  *
-- 
2.25.1