fix a few comments

diff --git a/CRM/Contact/Form/Search/Custom/FullText/Participant.php b/CRM/Contact/Form/Search/Custom/FullText/Participant.php
index 7a4503a92453d1419fa0774c714923f1462a7414..59e1f0b612c530d0469234f476cff4d7782f594a 100644 (file)
--- a/CRM/Contact/Form/Search/Custom/FullText/Participant.php
+++ b/CRM/Contact/Form/Search/Custom/FullText/Participant.php
@@ -41,6 +41,9 @@ class CRM_Contact_Form_Search_Custom_FullText_Participant extends CRM_Contact_Fo
     parent::__construct('Participant', ts('Participants'));
   }
 
+  /**
+   * @return bool
+   */
   public function isActive() {
     $config = CRM_Core_Config::singleton();
     return in_array('CiviEvent', $config->enableComponents) &&

diff --git a/CRM/Contact/Form/Search/Custom/MultipleValues.php b/CRM/Contact/Form/Search/Custom/MultipleValues.php
index c15246565a32faa37f0b8979eb8892063df1f99c..0e23374810606c44bf4d1c60be3339c2b6e9ad81 100644 (file)
--- a/CRM/Contact/Form/Search/Custom/MultipleValues.php
+++ b/CRM/Contact/Form/Search/Custom/MultipleValues.php
@@ -141,6 +141,14 @@ class CRM_Contact_Form_Search_Custom_MultipleValues extends CRM_Contact_Form_Sea
     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/PostalMailing.php b/CRM/Contact/Form/Search/Custom/PostalMailing.php
index 3635a85cba1fafe9409db4d39aa476a59f00ca30..66859d27e388da0acb4a9747e2c92090c4d1c58d 100644 (file)
--- a/CRM/Contact/Form/Search/Custom/PostalMailing.php
+++ b/CRM/Contact/Form/Search/Custom/PostalMailing.php
@@ -62,6 +62,14 @@ class CRM_Contact_Form_Search_Custom_PostalMailing extends CRM_Contact_Form_Sear
     $form->assign('elements', array('group_id'));
   }
 
+  /**
+   * @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/Sample.php b/CRM/Contact/Form/Search/Custom/Sample.php
index 1c9caca8efffeee2a9e3d02397749272606ed1f1..14abe4b379954ecc3d033ca6507b444431b73135 100644 (file)
--- a/CRM/Contact/Form/Search/Custom/Sample.php
+++ b/CRM/Contact/Form/Search/Custom/Sample.php
@@ -93,6 +93,14 @@ class CRM_Contact_Form_Search_Custom_Sample extends CRM_Contact_Form_Search_Cust
     return $summary;
   }
 
+  /**
+   * @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/ZipCodeRange.php b/CRM/Contact/Form/Search/Custom/ZipCodeRange.php
index debe5277a972e523f3099025b0f94899637a2556..414aa3b062511fd0b9c3ee395dbf51ae43990a89 100644 (file)
--- a/CRM/Contact/Form/Search/Custom/ZipCodeRange.php
+++ b/CRM/Contact/Form/Search/Custom/ZipCodeRange.php
@@ -83,6 +83,14 @@ class CRM_Contact_Form_Search_Custom_ZipCodeRange extends CRM_Contact_Form_Searc
     return $summary;
   }
 
+  /**
+   * @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/Contribute/Exception/InactiveContributionPageException.php b/CRM/Contribute/Exception/InactiveContributionPageException.php
index d8e67d621061704c4678fb052a43d5d4fbf305f3..5c8b82e65f01d98e74c8e64897c7d8356981314c 100644 (file)
--- a/CRM/Contribute/Exception/InactiveContributionPageException.php
+++ b/CRM/Contribute/Exception/InactiveContributionPageException.php
@@ -9,12 +9,21 @@
 class CRM_Contribute_Exception_InactiveContributionPageException extends Exception {
   private $id;
 
+  /**
+   * @param string $message
+   * @param int $id
+   */
   public function __construct($message, $id) {
     parent::__construct(ts($message));
     $this->id = $id;
     CRM_Core_Error::debug_log_message('inactive contribution page access attempted - page number ' . $id);
   }
 
+  /**
+   * Get Contribution page ID.
+   *
+   * @return int
+   */
   public function getID() {
     return $this->id;
   }

diff --git a/CRM/Core/BAO/RecurringEntity.php b/CRM/Core/BAO/RecurringEntity.php
index f214e164eed49e8b311a91399d526a9a33068eb2..0b74ca82d11c9263282863c50707eaf0f32c807e 100644 (file)
--- a/CRM/Core/BAO/RecurringEntity.php
+++ b/CRM/Core/BAO/RecurringEntity.php
@@ -35,6 +35,9 @@
 
 require_once 'packages/When/When.php';
 
+/**
+ * Class CRM_Core_BAO_RecurringEntity
+ */
 class CRM_Core_BAO_RecurringEntity extends CRM_Core_DAO_RecurringEntity {
 
   const RUNNING = 1;

diff --git a/CRM/Core/CodeGen/Util/Smarty.php b/CRM/Core/CodeGen/Util/Smarty.php
index ce11d28b3f38ef41573c2dc584f6d5b134e99b61..eff08a87824888101a76fced261799a79ca3a37f 100644 (file)
--- a/CRM/Core/CodeGen/Util/Smarty.php
+++ b/CRM/Core/CodeGen/Util/Smarty.php
@@ -1,5 +1,8 @@
 <?php
 
+/**
+ * Class CRM_Core_CodeGen_Util_Smarty
+ */
 class CRM_Core_CodeGen_Util_Smarty {
   /**
    * @var CRM_Core_CodeGen_Util_Smarty

diff --git a/CRM/Core/DAO.php b/CRM/Core/DAO.php
index 6edc424c07333935b657ac7e49a4f66f33d8001e..8b382d70dfd653cd9a6b410305f53b5ed9070bcd 100644 (file)
--- a/CRM/Core/DAO.php
+++ b/CRM/Core/DAO.php
@@ -459,6 +459,31 @@ class CRM_Core_DAO extends DB_DataObject {
     return $this;
   }
 
+  /**
+   * Deletes items from table which match current objects variables
+   *
+   * Returns the true on success
+   *
+   * for example
+   *
+   * Designed to be extended
+   *
+   * $object = new mytable();
+   * $object->ID=123;
+   * echo $object->delete(); // builds a conditon
+   *
+   * $object = new mytable();
+   * $object->whereAdd('age > 12');
+   * $object->limit(1);
+   * $object->orderBy('age DESC');
+   * $object->delete(true); // dont use object vars, use the conditions, limit and order.
+   *
+   * @param bool $useWhere (optional) If DB_DATAOBJECT_WHEREADD_ONLY is passed in then
+   *             we will build the condition only using the whereAdd's.  Default is to
+   *             build the condition only using the object parameters.
+   *
+   *     * @return mixed Int (No. of rows affected) on success, false on failure, 0 on no data affected
+   */
   public function delete($useWhere = FALSE) {
     $result = parent::delete($useWhere);
 

diff --git a/CRM/Core/FileSearchInterface.php b/CRM/Core/FileSearchInterface.php
index da37d7c0567e944ef6292bf2e31238d7d246e47e..dd41550b1cc89145d2c20ae3f5ea1cce41721ff1 100644 (file)
--- a/CRM/Core/FileSearchInterface.php
+++ b/CRM/Core/FileSearchInterface.php
@@ -1,5 +1,8 @@
 <?php
 
+/**
+ * Interface CRM_Core_FileSearchInterface
+ */
 interface CRM_Core_FileSearchInterface {
   const DEFAULT_SEARCH_LIMIT = 20;
   const DEFAULT_SEARCH_OFFSET = 0;

diff --git a/CRM/Core/LegacyErrorHandler.php b/CRM/Core/LegacyErrorHandler.php
index 57b8c80e6852f443cd54468c5ed3dda5f9ca320f..a25dc320c7e42d04808618891b51c1358cf44a3c 100644 (file)
--- a/CRM/Core/LegacyErrorHandler.php
+++ b/CRM/Core/LegacyErrorHandler.php
@@ -1,5 +1,8 @@
 <?php
 
+/**
+ * Class CRM_Core_LegacyErrorHandler
+ */
 class CRM_Core_LegacyErrorHandler {
   /**
    * @param \Civi\Core\Event\UnhandledExceptionEvent $event

diff --git a/CRM/Core/Page/Redirect.php b/CRM/Core/Page/Redirect.php
index 4498ecd0cd1a17f22da9ae2b69ea3e57c5d07c26..98b24af9f793c81553d8983a8f8cb4932468f3a3 100644 (file)
--- a/CRM/Core/Page/Redirect.php
+++ b/CRM/Core/Page/Redirect.php
@@ -14,16 +14,13 @@
 class CRM_Core_Page_Redirect extends CRM_Core_Page {
 
   /**
-   * Run page
+   * Run page.
    *
    * @param string $path
    * @param array $pageArgs
-   *
-   * @return string|void
    */
   public function run($path = NULL, $pageArgs = array()) {
     $url = self::createUrl($path, $_REQUEST, $pageArgs, TRUE);
-    // return $url;
     CRM_Utils_System::redirect($url);
   }
 

diff --git a/CRM/Core/Smarty/resources/String.php b/CRM/Core/Smarty/resources/String.php
index 932ec5abcb9080e69f954bae022f10c062ce679e..38f614ea754e79cfaf8443fd9d0443265ada53a3 100644 (file)
--- a/CRM/Core/Smarty/resources/String.php
+++ b/CRM/Core/Smarty/resources/String.php
@@ -31,6 +31,11 @@
  * @copyright CiviCRM LLC (c) 2004-2014
  * $Id$
  *
+ * @param $tpl_name
+ * @param $tpl_source
+ * @param $smarty_obj
+ *
+ * @return bool
  */
 function civicrm_smarty_resource_string_get_template($tpl_name, &$tpl_source, &$smarty_obj) {
   $tpl_source = $tpl_name;

diff --git a/CRM/Event/Form/ManageEvent/ScheduleReminders.php b/CRM/Event/Form/ManageEvent/ScheduleReminders.php
index c8f48dc952fe3a4c41042c889e858cc6d008a00f..e08aaa51292bdc0b3be10ee46c2f15f5e1ef961c 100644 (file)
--- a/CRM/Event/Form/ManageEvent/ScheduleReminders.php
+++ b/CRM/Event/Form/ManageEvent/ScheduleReminders.php
@@ -90,6 +90,9 @@ class CRM_Event_Form_ManageEvent_ScheduleReminders extends CRM_Event_Form_Manage
     $this->setPageTitle(ts('Scheduled Reminder'));
   }
 
+  /**
+   * @return string
+   */
   public function getTemplateFileName() {
     return 'CRM/Admin/Page/ScheduleReminders.tpl';
   }

diff --git a/CRM/Group/Page/AJAX.php b/CRM/Group/Page/AJAX.php
index 5482b3f52be178fa0627fc6f9e827f0c2aa750ff..2a346f8eac9c2a9065ec764e8cb599a6526c1b89 100644 (file)
--- a/CRM/Group/Page/AJAX.php
+++ b/CRM/Group/Page/AJAX.php
@@ -36,6 +36,11 @@
  * This class contains the functions that are called using AJAX (jQuery)
  */
 class CRM_Group_Page_AJAX {
+  /**
+   * Get list of groups.
+   *
+   * @return array
+   */
   public static function getGroupList() {
     $params = $_REQUEST;