From: Eileen McNaughton <eileen@fuzion.co.nz>
Date: Mon, 2 Feb 2015 02:49:18 +0000 (+1300)
Subject: some comment fixes
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=decced8b231940f493fb11283ad08ea965fb4fb4;p=civicrm-core.git

some comment fixes
---

diff --git a/CRM/Contact/Form/Search/Custom/FullText/Case.php b/CRM/Contact/Form/Search/Custom/FullText/Case.php
index 9a02f37bb9..31729f67fc 100644
--- a/CRM/Contact/Form/Search/Custom/FullText/Case.php
+++ b/CRM/Contact/Form/Search/Custom/FullText/Case.php
@@ -42,6 +42,8 @@ class CRM_Contact_Form_Search_Custom_FullText_Case extends CRM_Contact_Form_Sear
   }
 
   /**
+   * Is CiviCase active?
+   *
    * @return bool
    */
   public function isActive() {
diff --git a/CRM/Contact/Form/Search/Interface.php b/CRM/Contact/Form/Search/Interface.php
index 08f25e5f2d..63769df56c 100644
--- a/CRM/Contact/Form/Search/Interface.php
+++ b/CRM/Contact/Form/Search/Interface.php
@@ -45,7 +45,6 @@ interface CRM_Contact_Form_Search_Interface {
    * Builds the quickform for this search.
    *
    * @param CRM_Core_Form $form
-   * @return
    */
   public function buildForm(&$form);
 
@@ -79,8 +78,6 @@ interface CRM_Contact_Form_Search_Interface {
    * @param int $offset
    * @param int $rowcount
    * @param null $sort
-   *
-   * @return
    */
   public function contactIDs($offset = 0, $rowcount = 0, $sort = NULL);
 
@@ -94,8 +91,6 @@ interface CRM_Contact_Form_Search_Interface {
    * @param null $sort
    * @param bool $includeContactIDs
    * @param bool $justIDs
-   *
-   * @return
    */
   public function all($offset = 0, $rowcount = 0, $sort = NULL, $includeContactIDs = FALSE, $justIDs = FALSE);
 
@@ -117,8 +112,6 @@ interface CRM_Contact_Form_Search_Interface {
    * The where clause for the query.
    *
    * @param bool $includeContactIDs
-   *
-   * @return
    */
   public function where($includeContactIDs = FALSE);
 
diff --git a/CRM/Core/Permission/Drupal8.php b/CRM/Core/Permission/Drupal8.php
index d093dccf96..e3054a0418 100644
--- a/CRM/Core/Permission/Drupal8.php
+++ b/CRM/Core/Permission/Drupal8.php
@@ -43,6 +43,8 @@ class CRM_Core_Permission_Drupal8 extends CRM_Core_Permission_DrupalBase {
    * @param string $str
    *   The permission to check.
    *
+   * @param null $contactID
+   *
    * @return bool
    */
   public function check($str, $contactID = NULL) {
diff --git a/CRM/Report/Form/Contact/Summary.php b/CRM/Report/Form/Contact/Summary.php
index a5e591e2e6..f29e95e8db 100644
--- a/CRM/Report/Form/Contact/Summary.php
+++ b/CRM/Report/Form/Contact/Summary.php
@@ -258,6 +258,8 @@ class CRM_Report_Form_Contact_Summary extends CRM_Report_Form {
 
   /**
    * @param $rows
+   *
+   * @return bool
    */
   private function _initBasicRow(&$rows, &$entryFound, $row, $rowId, $rowNum, $types) {
     if (!array_key_exists($rowId, $row)) {
diff --git a/CRM/Report/Form/Contribute/History.php b/CRM/Report/Form/Contribute/History.php
index e2ac3fc46e..e0d2ca89bb 100644
--- a/CRM/Report/Form/Contribute/History.php
+++ b/CRM/Report/Form/Contribute/History.php
@@ -420,7 +420,10 @@ class CRM_Report_Form_Contribute_History extends CRM_Report_Form {
 
   /**
    * Override to set limit is 10
+   *
    * @param int $rowCount
+   *
+   * @return array|void
    */
   public function limit($rowCount = self::ROW_COUNT_LIMIT) {
     parent::limit($rowCount);
diff --git a/CRM/Report/Form/Contribute/Repeat.php b/CRM/Report/Form/Contribute/Repeat.php
index 07b24399e9..2d5bf61055 100644
--- a/CRM/Report/Form/Contribute/Repeat.php
+++ b/CRM/Report/Form/Contribute/Repeat.php
@@ -268,6 +268,8 @@ class CRM_Report_Form_Contribute_Repeat extends CRM_Report_Form {
 
   /**
    * @param bool $tableCol
+   *
+   * @return array|void
    */
   public function groupBy($tableCol = FALSE) {
     $this->_groupBy = "";
diff --git a/CRM/Report/Form/Contribute/TopDonor.php b/CRM/Report/Form/Contribute/TopDonor.php
index fdb055fdc8..2dd720e10b 100644
--- a/CRM/Report/Form/Contribute/TopDonor.php
+++ b/CRM/Report/Form/Contribute/TopDonor.php
@@ -382,6 +382,8 @@ ORDER BY civicrm_contribution_total_amount_sum DESC
 
   /**
    * @param int $rowCount
+   *
+   * @return array|void
    */
   public function limit($rowCount = CRM_Report_Form::ROW_COUNT_LIMIT) {
     // lets do the pager if in html mode
diff --git a/CRM/Report/Form/Event/Income.php b/CRM/Report/Form/Event/Income.php
index decdb73262..ccd72cfcba 100644
--- a/CRM/Report/Form/Event/Income.php
+++ b/CRM/Report/Form/Event/Income.php
@@ -279,6 +279,8 @@ class CRM_Report_Form_Event_Income extends CRM_Report_Form_Event {
 
   /**
    * @param int $rowCount
+   *
+   * @return array|void
    */
   public function limit($rowCount = self::ROW_COUNT_LIMIT) {
     parent::limit($rowCount);