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

a few comment fixes
---

diff --git a/CRM/Campaign/Page/DashBoard.php b/CRM/Campaign/Page/DashBoard.php
index d6a98a37e0..598906e628 100644
--- a/CRM/Campaign/Page/DashBoard.php
+++ b/CRM/Campaign/Page/DashBoard.php
@@ -372,6 +372,11 @@ class CRM_Campaign_Page_DashBoard extends CRM_Core_Page {
     return $surveysData;
   }
 
+  /**
+   * Browse petitions.
+   *
+   * @return mixed|null
+   */
   public function browsePetition() {
     // ensure valid javascript - this must have a value set
     $this->assign('searchParams', json_encode(NULL));
diff --git a/CRM/Contact/Form/Search/Custom/FullText/AbstractPartialQuery.php b/CRM/Contact/Form/Search/Custom/FullText/AbstractPartialQuery.php
index e4a69036f8..8a97932502 100644
--- a/CRM/Contact/Form/Search/Custom/FullText/AbstractPartialQuery.php
+++ b/CRM/Contact/Form/Search/Custom/FullText/AbstractPartialQuery.php
@@ -64,6 +64,11 @@ abstract class CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery {
     return $this->label;
   }
 
+  /**
+   * Get name.
+   *
+   * @return string
+   */
   public function getName() {
     return $this->name;
   }
diff --git a/CRM/Contact/Form/Search/Custom/FullText/Contribution.php b/CRM/Contact/Form/Search/Custom/FullText/Contribution.php
index d68719760a..6604fe2908 100644
--- a/CRM/Contact/Form/Search/Custom/FullText/Contribution.php
+++ b/CRM/Contact/Form/Search/Custom/FullText/Contribution.php
@@ -112,6 +112,13 @@ WHERE      ({$this->matchText('civicrm_contact c', array('sort_name', 'display_n
     return $tables;
   }
 
+  /**
+   * Move IDs.
+   *
+   * @param string $fromTable
+   * @param string $toTable
+   * @param int $limit
+   */
   public function moveIDs($fromTable, $toTable, $limit) {
     $sql = "
 INSERT INTO {$toTable}
diff --git a/CRM/Core/BAO/ConfigSetting.php b/CRM/Core/BAO/ConfigSetting.php
index 30906a7281..f6b4d74638 100644
--- a/CRM/Core/BAO/ConfigSetting.php
+++ b/CRM/Core/BAO/ConfigSetting.php
@@ -680,12 +680,19 @@ WHERE  option_group_id = (
     return TRUE;
   }
 
+  /**
+   * Disable specified component.
+   *
+   * @param string $componentName
+   *
+   * @return bool
+   */
   public static function disableComponent($componentName) {
     $config = CRM_Core_Config::singleton();
     if (!in_array($componentName, $config->enableComponents) ||
       !array_key_exists($componentName, CRM_Core_Component::getComponents())
     ) {
-      // post-condition satisified
+      // Post-condition is satisfied.
       return TRUE;
     }
 
@@ -699,6 +706,11 @@ WHERE  option_group_id = (
     return TRUE;
   }
 
+  /**
+   * Set enabled components.
+   *
+   * @param array $enabledComponents
+   */
   public static function setEnabledComponents($enabledComponents) {
     $config = CRM_Core_Config::singleton();
     $components = CRM_Core_Component::getComponents();
diff --git a/CRM/Report/Interface.php b/CRM/Report/Interface.php
index b556430ee1..99b4a43cc7 100644
--- a/CRM/Report/Interface.php
+++ b/CRM/Report/Interface.php
@@ -44,7 +44,6 @@ interface CRM_Report_Interface {
   /**
    * Builds the quickform for this search
    * @param $form
-   * @return
    */
   public function buildForm(&$form);
 
diff --git a/CRM/Upgrade/Incremental/php/FourFour.php b/CRM/Upgrade/Incremental/php/FourFour.php
index 853797202f..8b24dc6d67 100644
--- a/CRM/Upgrade/Incremental/php/FourFour.php
+++ b/CRM/Upgrade/Incremental/php/FourFour.php
@@ -379,6 +379,15 @@ ALTER TABLE civicrm_dashboard
     $this->addTask(ts('Update saved search information'), 'changeSavedSearch');
   }
 
+  /**
+   * Upgrade image URLs.
+   *
+   * @param \CRM_Queue_TaskContext $ctx
+   * @param $startId
+   * @param $endId
+   *
+   * @return bool
+   */
   public static function upgradeImageUrls(CRM_Queue_TaskContext $ctx, $startId, $endId) {
     $dao = self::findContactImageUrls($startId, $endId);
     $failures = array();
@@ -408,6 +417,13 @@ ALTER TABLE civicrm_dashboard
     return TRUE;
   }
 
+  /**
+   * Change saved search.
+   *
+   * @param \CRM_Queue_TaskContext $ctx
+   *
+   * @return bool
+   */
   public static function changeSavedSearch(CRM_Queue_TaskContext $ctx) {
     $membershipStatuses = array_flip(CRM_Member_PseudoConstant::membershipStatus());
 
diff --git a/CRM/Utils/REST.php b/CRM/Utils/REST.php
index 6271bafc91..9a66a9febb 100644
--- a/CRM/Utils/REST.php
+++ b/CRM/Utils/REST.php
@@ -455,6 +455,11 @@ class CRM_Utils_REST {
     CRM_Utils_System::civiExit();
   }
 
+  /**
+   * Return smarty-generated API Documentation.
+   *
+   * @return string
+   */
   public static function APIDoc() {
 
     CRM_Utils_System::setTitle("API Parameters");
@@ -583,6 +588,11 @@ class CRM_Utils_REST {
     CRM_Utils_System::civiExit();
   }
 
+  /**
+   * Run ajax request.
+   *
+   * @return array
+   */
   public static function ajax() {
     $requestParams = CRM_Utils_Request::exportValues();
 
diff --git a/Civi/CiUtil/Command/LsCommand.php b/Civi/CiUtil/Command/LsCommand.php
index c265d1e130..8cdb679b05 100644
--- a/Civi/CiUtil/Command/LsCommand.php
+++ b/Civi/CiUtil/Command/LsCommand.php
@@ -1,6 +1,11 @@
 <?php
 namespace Civi\CiUtil\Command;
 
+/**
+ * Class LsCommand
+ *
+ * @package Civi\CiUtil\Command
+ */
 class LsCommand {
   public static function main($argv) {
     $paths = $argv;