add a few comment blocks

diff --git a/CRM/Case/BAO/CaseType.php b/CRM/Case/BAO/CaseType.php
index 3a787eee8782bf7930aa5cf861924f5dcc4b1e43..f8f601f36b36d0561c0b9925f9205525d626b165 100644 (file)
--- a/CRM/Case/BAO/CaseType.php
+++ b/CRM/Case/BAO/CaseType.php
@@ -86,6 +86,14 @@ class CRM_Case_BAO_CaseType extends CRM_Case_DAO_CaseType {
     return $caseTypeDAO->save();
   }
 
+  /**
+   * Generate and assign an arbitrary value to a field of a test object.
+   *
+   * @param string $fieldName
+   * @param array $fieldDef
+   * @param int $counter
+   *   The globally-unique ID of the test object.
+   */
   protected function assignTestValue($fieldName, &$fieldDef, $counter) {
     if ($fieldName == 'definition') {
       $this->{$fieldName} = "<CaseType><name>TestCaseType{$counter}</name></CaseType>";

diff --git a/CRM/Case/ManagedEntities.php b/CRM/Case/ManagedEntities.php
index ae9906b7d03973d1f37f18d8f42c5a3df5ba205f..4cef93581c62adb1df814a3764b229d234d75682 100644 (file)
--- a/CRM/Case/ManagedEntities.php
+++ b/CRM/Case/ManagedEntities.php
@@ -1,5 +1,8 @@
 <?php
 
+/**
+ * Class CRM_Case_ManagedEntities
+ */
 class CRM_Case_ManagedEntities {
 
   /**

diff --git a/CRM/Contact/Form/Search/Custom/DateAdded.php b/CRM/Contact/Form/Search/Custom/DateAdded.php
index adbfa25a3b1def940769032e1d147655322eef10..c08dcca49c4a9202aeb16a6e438aab765f408ed7 100644 (file)
--- a/CRM/Contact/Form/Search/Custom/DateAdded.php
+++ b/CRM/Contact/Form/Search/Custom/DateAdded.php
@@ -108,6 +108,14 @@ class CRM_Contact_Form_Search_Custom_DateAdded extends CRM_Contact_Form_Search_C
     return NULL;
   }
 
+  /**
+   * @param int $offset
+   * @param int $rowcount
+   * @param null $sort
+   * @param bool $returnSQL
+   *
+   * @return string
+   */
   public function contactIDs($offset = 0, $rowcount = 0, $sort = NULL, $returnSQL = FALSE) {
     return $this->all($offset, $rowcount, $sort, FALSE, TRUE);
   }

diff --git a/CRM/Contact/Form/Search/Custom/FullText/AbstractPartialQuery.php b/CRM/Contact/Form/Search/Custom/FullText/AbstractPartialQuery.php
index 9d2ecd4141da6525afeca601cd22406ebf6ca6a8..a1cdfa8fd1d1570ab5865ed3222723e66c962db1 100644 (file)
--- a/CRM/Contact/Form/Search/Custom/FullText/AbstractPartialQuery.php
+++ b/CRM/Contact/Form/Search/Custom/FullText/AbstractPartialQuery.php
@@ -45,6 +45,8 @@ abstract class CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery {
   protected $label;
 
   /**
+   * Class constructor.
+   *
    * @param string $name
    * @param string $label
    */

diff --git a/CRM/Contact/Form/Search/Custom/FullText/Activity.php b/CRM/Contact/Form/Search/Custom/FullText/Activity.php
index f45da6be62d34915c609afff6b7f7c75bd5d763d..a8e122111f9e6610634535d41e6e3747fc37de80 100644 (file)
--- a/CRM/Contact/Form/Search/Custom/FullText/Activity.php
+++ b/CRM/Contact/Form/Search/Custom/FullText/Activity.php
@@ -34,10 +34,16 @@
  */
 class CRM_Contact_Form_Search_Custom_FullText_Activity extends CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery {
 
+  /**
+   * Class constructor.
+   */
   public function __construct() {
     parent::__construct('Activity', ts('Activities'));
   }
 
+  /**
+   * @return bool
+   */
   public function isActive() {
     return CRM_Core_Permission::check('view all activities');
   }

diff --git a/CRM/Contact/Form/Search/Custom/FullText/Case.php b/CRM/Contact/Form/Search/Custom/FullText/Case.php
index 29dd5f0dc99efa20a4b5a18cab127d1d4f06e3ef..a291ce5065f77918062d20e9a66b430fc1465070 100644 (file)
--- a/CRM/Contact/Form/Search/Custom/FullText/Case.php
+++ b/CRM/Contact/Form/Search/Custom/FullText/Case.php
@@ -38,6 +38,9 @@ class CRM_Contact_Form_Search_Custom_FullText_Case extends CRM_Contact_Form_Sear
     parent::__construct('Case', ts('Cases'));
   }
 
+  /**
+   * @return bool
+   */
   public function isActive() {
     $config = CRM_Core_Config::singleton();
     return in_array('CiviCase', $config->enableComponents);

diff --git a/CRM/Contact/Form/Search/Custom/FullText/Contact.php b/CRM/Contact/Form/Search/Custom/FullText/Contact.php
index f9290c87673b427511c8c2c859d89eb08df5ac0f..85631655e7d150521e36bdb2f33d7e82bbe9f6ed 100644 (file)
--- a/CRM/Contact/Form/Search/Custom/FullText/Contact.php
+++ b/CRM/Contact/Form/Search/Custom/FullText/Contact.php
@@ -41,6 +41,9 @@ class CRM_Contact_Form_Search_Custom_FullText_Contact extends CRM_Contact_Form_S
     parent::__construct('Contact', ts('Contacts'));
   }
 
+  /**
+   * @return bool
+   */
   public function isActive() {
     return CRM_Core_Permission::check('view all contacts');
   }

diff --git a/CRM/Contact/Form/Search/Custom/FullText/Contribution.php b/CRM/Contact/Form/Search/Custom/FullText/Contribution.php
index 6ef97a21790920874c57db3b1983aeffdebeee01..d68719760a018b466d2b4c21c9d20ba3dcddf5bb 100644 (file)
--- a/CRM/Contact/Form/Search/Custom/FullText/Contribution.php
+++ b/CRM/Contact/Form/Search/Custom/FullText/Contribution.php
@@ -41,6 +41,9 @@ class CRM_Contact_Form_Search_Custom_FullText_Contribution extends CRM_Contact_F
     parent::__construct('Contribution', ts('Contributions'));
   }
 
+  /**
+   * @return bool
+   */
   public function isActive() {
     $config = CRM_Core_Config::singleton();
     return in_array('CiviContribute', $config->enableComponents) &&

diff --git a/CRM/Contact/Form/Search/Custom/FullText/Membership.php b/CRM/Contact/Form/Search/Custom/FullText/Membership.php
index aea55a1bbf6a00182b0d4a846f8e10b448e773ff..250aeb044afada26bcf33cb4992c41a2649541b3 100644 (file)
--- a/CRM/Contact/Form/Search/Custom/FullText/Membership.php
+++ b/CRM/Contact/Form/Search/Custom/FullText/Membership.php
@@ -41,6 +41,9 @@ class CRM_Contact_Form_Search_Custom_FullText_Membership extends CRM_Contact_For
     parent::__construct('Membership', ts('Memberships'));
   }
 
+  /**
+   * @return bool
+   */
   public function isActive() {
     $config = CRM_Core_Config::singleton();
     return in_array('CiviMember', $config->enableComponents) &&

diff --git a/api/v3/Acl.php b/api/v3/Acl.php
index 9bc52f32fb1d2843de2bf03cceaaa1e342d14e2c..5e6018b72e03b320e046698589e71096e3dd0cb9 100644 (file)
--- a/api/v3/Acl.php
+++ b/api/v3/Acl.php
@@ -33,7 +33,7 @@
  */
 
 /**
- * Save an acl
+ * Save an acl.
  *
  * {@getfields acl_create}
  * @example aclCreate.php
@@ -48,10 +48,7 @@ function civicrm_api3_acl_create($params) {
 }
 
 /**
- * Get an acl
- *
- * {@getfields acl_get}
- * @example aclCreate.php
+ * Get an acl.
  *
  * @param array $params
  *
@@ -63,10 +60,7 @@ function civicrm_api3_acl_get($params) {
 }
 
 /**
- * Delete an acl
- *
- * {@getfields acl_delete}
- * @example aclCreate.php
+ * Delete an acl.
  *
  * @param array $params
  *

diff --git a/api/v3/Generic/Getactions.php b/api/v3/Generic/Getactions.php
index d8b7fb4adb96f198910fe33d145a041fc40ea820..bdefaa06828d07b8266e4abccf8c8325905d0c59 100644 (file)
--- a/api/v3/Generic/Getactions.php
+++ b/api/v3/Generic/Getactions.php
@@ -26,6 +26,8 @@
  */
 
 /**
+ * Get available api actions.
+ *
  * @param array $apiRequest
  *
  * @return array

diff --git a/api/v3/Generic/Update.php b/api/v3/Generic/Update.php
index 095018bc1be9f1120e8fd188a1b075bbeee93985..3ccfece1eca8ec38e1ae8140cdb0202c083767a3 100644 (file)
--- a/api/v3/Generic/Update.php
+++ b/api/v3/Generic/Update.php
@@ -26,7 +26,9 @@
  */
 
 /**
- * Update function is basically a hack to get around issues listed in
+ * Update function is basically a hack.
+ *
+ * We want to remove it but must resolve issues in
  * http://issues.civicrm.org/jira/browse/CRM-12144
  *
  * It is not recommended & if update doesn't work & fix does then update will not be fixed

diff --git a/api/v3/Im.php b/api/v3/Im.php
index 8101cb32e7369c20c587c8c46bee348d48f5b7ec..448b3374818152a3591ea4d4b354d7faea9eda01 100644 (file)
--- a/api/v3/Im.php
+++ b/api/v3/Im.php
@@ -35,10 +35,7 @@
  */
 
 /**
- *  Add an IM for a contact
- *
- * Allowed @params array keys are:
- * {@getfields im_create}
+ *  Add an IM for a contact.
  *
  * @param array $params
  *
@@ -50,9 +47,10 @@ function civicrm_api3_im_create($params) {
 }
 
 /**
- * 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.
  */
@@ -61,7 +59,7 @@ function _civicrm_api3_im_create_spec(&$params) {
 }
 
 /**
- * Deletes an existing IM
+ * Deletes an existing IM.
  *
  * @param array $params
  *

diff --git a/api/v3/Job.php b/api/v3/Job.php
index f1cc4997dee97583df954389a98c7666112bf485..65436f8d4850bb44e635ae0ff4538abe494a7684 100644 (file)
--- a/api/v3/Job.php
+++ b/api/v3/Job.php
@@ -315,7 +315,7 @@ function civicrm_api3_job_process_mailing($params) {
 }
 
 /**
- * Process sms queue
+ * Process sms queue.
  *
  * @param array $params
  *

diff --git a/api/v3/utils.php b/api/v3/utils.php
index c2ada33f336073e367ef3603ec0bc87a0fb7f28a..0e1cde62b9e5d4f3e5554e0b2fd3cab098b5b454 100644 (file)
--- a/api/v3/utils.php
+++ b/api/v3/utils.php
@@ -73,6 +73,8 @@ function civicrm_api3_verify_one_mandatory($params, $daoName = NULL, $keyoptions
  * @param array $keys
  *   List of required fields. A value can be an array denoting that either this or that is required.
  * @param bool $verifyDAO
+ *
+ * @throws \API_Exception
  */
 function civicrm_api3_verify_mandatory($params, $daoName = NULL, $keys = array(), $verifyDAO = TRUE) {
 

diff --git a/bin/cli.class.php b/bin/cli.class.php
index 10bb27db0d472a27bd73a111659237aed45e8e18..f7999d383ad960904a3b0b55820364be75c41824 100644 (file)
--- a/bin/cli.class.php
+++ b/bin/cli.class.php
@@ -77,6 +77,11 @@ class civicrm_cli {
     return TRUE;
   }
 
+  /**
+   * Ensure function is being run from the cli.
+   *
+   * @return bool
+   */
   public function _accessing_from_cli() {
     if (PHP_SAPI === 'cli') {
       return TRUE;
@@ -370,6 +375,9 @@ class civicrm_cli_csv_file extends civicrm_cli {
     parent::initialize();
   }
 
+  /**
+   * Run CLI function.
+   */
   public function run() {
     $this->row = 1;
     $handle = fopen($this->_file, "r");
@@ -402,7 +410,6 @@ class civicrm_cli_csv_file extends civicrm_cli {
       $this->processLine($params);
     }
     fclose($handle);
-    return NULL;
   }
 
   /* return a params as expected */

diff --git a/tests/phpunit/CRM/Utils/QueryFormatterTest.php b/tests/phpunit/CRM/Utils/QueryFormatterTest.php
index 79e34ed6d50798a878daf4f2d2de8fdb0d5682be..b57308c2390ab6115458f1c494b4389f11089aaa 100644 (file)
--- a/tests/phpunit/CRM/Utils/QueryFormatterTest.php
+++ b/tests/phpunit/CRM/Utils/QueryFormatterTest.php
@@ -7,6 +7,11 @@ require_once 'CiviTest/CiviUnitTestCase.php';
  */
 class CRM_Utils_QueryFormatterTest extends CiviUnitTestCase {
 
+  /**
+   * Generate data for tests to iterate through.
+   *
+   * @return array
+   */
   public function dataProvider() {
     // Array(0=>$inputText, 1=>$language, 2=>$options, 3=>$expectedText).
     $cases = array();