INFRA-132 - Convert // comments to docblocks

diff --git a/CRM/Contact/Form/Search/Custom/ActivitySearch.php b/CRM/Contact/Form/Search/Custom/ActivitySearch.php
index a11cfc0049ce75554ceada97ccab891e890cc23e..54ed4e595d2224c50bf3ff91eca73d14695ce93f 100644 (file)
--- a/CRM/Contact/Form/Search/Custom/ActivitySearch.php
+++ b/CRM/Contact/Form/Search/Custom/ActivitySearch.php
@@ -358,9 +358,12 @@ ORDER BY contact_a.sort_name';
     return implode(' AND ', $clauses);
   }
 
-  /**
+  /*
    * Functions below generally don't need to be modified
-   * @return int
+   */
+
+  /**
+   * @inheritDoc
    */
   public function count() {
     $sql = $this->all();

diff --git a/CRM/Contact/Form/Search/Custom/ContributionAggregate.php b/CRM/Contact/Form/Search/Custom/ContributionAggregate.php
index 7c8e246f164565c3156a921f624f84805a10258b..244b4c6d8d6aa7cc545898cb26845c01b4076b5c 100644 (file)
--- a/CRM/Contact/Form/Search/Custom/ContributionAggregate.php
+++ b/CRM/Contact/Form/Search/Custom/ContributionAggregate.php
@@ -252,9 +252,13 @@ civicrm_contact AS contact_a
     return implode(' AND ', $clauses);
   }
 
-  /**
+  /*
    * Functions below generally don't need to be modified
    */
+
+  /**
+   * @inheritDoc
+   */
   public function count() {
     $sql = $this->all();
 

diff --git a/CRM/Contact/Form/Search/Custom/EmployerListing.php b/CRM/Contact/Form/Search/Custom/EmployerListing.php
index 88e51f7aabb3c038d5f1eb279652a5740d0d8f72..e3545d2e4c6bab448c40a57e72787a61c2dc8d8d 100644 (file)
--- a/CRM/Contact/Form/Search/Custom/EmployerListing.php
+++ b/CRM/Contact/Form/Search/Custom/EmployerListing.php
@@ -241,6 +241,10 @@ class CRM_Contact_Form_Search_Custom_EmployerListing implements CRM_Contact_Form
   /*
    * Functions below generally don't need to be modified
    */
+
+  /**
+   * @inheritDoc
+   */
   public function count() {
     $sql = $this->all();
 

diff --git a/CRM/Contact/Form/Search/Custom/EventAggregate.php b/CRM/Contact/Form/Search/Custom/EventAggregate.php
index 1c38c06f3d7bc299f19509575d6218cf7057e49a..1b6ee7ad2840e3939a9639e127c63aedd947073b 100644 (file)
--- a/CRM/Contact/Form/Search/Custom/EventAggregate.php
+++ b/CRM/Contact/Form/Search/Custom/EventAggregate.php
@@ -303,6 +303,10 @@ class CRM_Contact_Form_Search_Custom_EventAggregate extends CRM_Contact_Form_Sea
   /*
    * Functions below generally don't need to be modified
    */
+
+  /**
+   * @inheritDoc
+   */
   public function count() {
     $sql = $this->all();
 

diff --git a/CRM/Contact/Form/Search/Custom/Group.php b/CRM/Contact/Form/Search/Custom/Group.php
index 4e55632257d053c3db8076784c9ddccb00584200..e7dd79ec04020be778b71937ae886cb62ce5c29f 100644 (file)
--- a/CRM/Contact/Form/Search/Custom/Group.php
+++ b/CRM/Contact/Form/Search/Custom/Group.php
@@ -595,8 +595,9 @@ WHERE  gcc.group_id = {$ssGroup->id}
   /*
    * Functions below generally don't need to be modified
    */
+
   /**
-   * @return mixed
+   * @inheritDoc
    */
   public function count() {
     $sql = $this->all();

diff --git a/CRM/Contact/Form/Search/Custom/TagContributions.php b/CRM/Contact/Form/Search/Custom/TagContributions.php
index e2172f16cf6aebff6135d0a2b2851273a78a3235..a88ded69d87c2ad8906950613c1727168e8be0ac 100644 (file)
--- a/CRM/Contact/Form/Search/Custom/TagContributions.php
+++ b/CRM/Contact/Form/Search/Custom/TagContributions.php
@@ -209,8 +209,9 @@ WHERE  $where
   /*
    * Functions below generally don't need to be modified
    */
+
   /**
-   * @return mixed
+   * @inheritDoc
    */
   public function count() {
     $sql = $this->all();

diff --git a/CRM/Contact/Selector.php b/CRM/Contact/Selector.php
index 1a739ebe3fa5b1d663704ac26197ba49a31fcd1e..79136236e7e6b56a7bc1cb1d47b8afb55937b3d5 100644 (file)
--- a/CRM/Contact/Selector.php
+++ b/CRM/Contact/Selector.php
@@ -1120,7 +1120,6 @@ SELECT DISTINCT 'civicrm_contact', contact_a.id, contact_a.id, '$cacheKey', cont
   /**
    * Get colunmn headers for search selector
    *
-   *
    * @return array
    */
   private static function &_getColumnHeaders() {

diff --git a/CRM/Core/Config.php b/CRM/Core/Config.php
index 3060cc137e469557fc31a8e77d09c55b7b142f1a..c83608356746322fbda9e6120bb4a1f863ad529a 100644 (file)
--- a/CRM/Core/Config.php
+++ b/CRM/Core/Config.php
@@ -694,7 +694,9 @@ class CRM_Core_Config extends CRM_Core_Config_Variables {
     CRM_Core_DAO::executeQuery($query);
   }
 
-  // This method should initialize auth sources
+  /**
+   * This method should initialize auth sources
+   */
   public function initAuthSrc() {
     $session = CRM_Core_Session::singleton();
     if ($session->get('userID') && !$session->get('authSrc')) {

diff --git a/CRM/Grant/Selector/Search.php b/CRM/Grant/Selector/Search.php
index 591b6625a091b9ba5336fee393e0bfbc93eca4c3..2e62a1716c380f424294046fb111d90379ddcb98 100644 (file)
--- a/CRM/Grant/Selector/Search.php
+++ b/CRM/Grant/Selector/Search.php
@@ -181,7 +181,7 @@ class CRM_Grant_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co
    * - View
    * - Edit
    *
-   * @param null $key
+   * @param string|null $key
    *
    * @return array
    */

diff --git a/CRM/Report/Form/Mailing/Summary.php b/CRM/Report/Form/Mailing/Summary.php
index 91246af8d8a4af90d9090b2bd511bc3e19676f6e..fa8119829016c07c418472f03acc766de85e12de 100644 (file)
--- a/CRM/Report/Form/Mailing/Summary.php
+++ b/CRM/Report/Form/Mailing/Summary.php
@@ -277,7 +277,9 @@ class CRM_Report_Form_Mailing_Summary extends CRM_Report_Form {
     parent::preProcess();
   }
 
-  // manipulate the select function to query count functions
+  /**
+   * manipulate the select function to query count functions
+   */
   public function select() {
 
     $count_tables = array(

diff --git a/CRM/Utils/System.php b/CRM/Utils/System.php
index c252acecbad28d9bebb9e2b8175312d0723addfa..30d6c631b34ce0db3d137947802c3c62bdb6ba0e 100644 (file)
--- a/CRM/Utils/System.php
+++ b/CRM/Utils/System.php
@@ -285,7 +285,9 @@ class CRM_Utils_System {
     return $config->userSystem->logout();
   }
 
-  // this is a very drupal specific function for now
+  /**
+   * this is a very drupal specific function for now
+   */
   public static function updateCategories() {
     $config = CRM_Core_Config::singleton();
     if ($config->userSystem->is_drupal) {

diff --git a/tests/phpunit/CRM/Event/BAO/AdditionalPaymentTest.php b/tests/phpunit/CRM/Event/BAO/AdditionalPaymentTest.php
index abd5f28d6db776a9edcbb3dbc7f1d7c0d58da431..fcd44b520a9637176853cead02a725e8adb684a2 100644 (file)
--- a/tests/phpunit/CRM/Event/BAO/AdditionalPaymentTest.php
+++ b/tests/phpunit/CRM/Event/BAO/AdditionalPaymentTest.php
@@ -166,7 +166,9 @@ class CRM_Event_BAO_AdditionalPaymentTest extends CiviUnitTestCase {
     return array($participant, $contribution);
   }
 
-  // CRM-13964
+  /**
+   * CRM-13964
+   */
   public function testAddPartialPayment() {
     $feeAmt = 100;
     $amtPaid = 60;

diff --git a/tests/phpunit/HelloTest.php b/tests/phpunit/HelloTest.php
index 4f161d51b19d219ab331ddd95d7760d3a5619425..970722131e400084195fd792c79595c07eda0c61 100644 (file)
--- a/tests/phpunit/HelloTest.php
+++ b/tests/phpunit/HelloTest.php
@@ -70,7 +70,9 @@ class HelloTest extends PHPUnit_Framework_TestCase {
     unset($this->abc);
   }
 
-  // test the toString function
+  /**
+   * test the toString function
+   */
   public function testHello() {
     $result = $this->abc;
     $expected = 'hello';

diff --git a/tests/phpunit/WebTest/Contact/AdvancedSearchTest.php b/tests/phpunit/WebTest/Contact/AdvancedSearchTest.php
index 4443d89b56e5acf915f2d8a9609d8241a74f2c10..6dd8abadec85322a6d1c854226cbb2a9a20991f3 100644 (file)
--- a/tests/phpunit/WebTest/Contact/AdvancedSearchTest.php
+++ b/tests/phpunit/WebTest/Contact/AdvancedSearchTest.php
@@ -327,7 +327,9 @@ class WebTest_Contact_AdvancedSearchTest extends CiviSeleniumTestCase {
     $this->click("xpath=//div[@id='activity']/table/tbody//tr/td[2]/label[text()='Activity Status']/../label[text()='Completed']");
   }
 
-  // function to fill demographic search details
+  /**
+   * function to fill demographic search details
+   */
   public function addDemographicSearchDetail() {
     // fill birth date range
     $this->select("birth_date_relative", "value=0");
@@ -367,7 +369,9 @@ class WebTest_Contact_AdvancedSearchTest extends CiviSeleniumTestCase {
     $this->select("contribution_currency_type", "USD");
   }
 
-  // function to fill participant search details
+  /**
+   * function to fill participant search details
+   */
   public function addParticipantSearchDetail() {
     // fill event name
     $this->select2("event_id", "Fall Fundraiser Dinner");

diff --git a/tests/phpunit/WebTest/Contact/SearchTest.php b/tests/phpunit/WebTest/Contact/SearchTest.php
index 7d62358848c15cd716fa9da92cccdcc4e4177e66..083ad8bdb4045005196a4c9c6224920e22f5f237 100644 (file)
--- a/tests/phpunit/WebTest/Contact/SearchTest.php
+++ b/tests/phpunit/WebTest/Contact/SearchTest.php
@@ -179,7 +179,9 @@ class WebTest_Contact_SearchTest extends CiviSeleniumTestCase {
     $self->assertTrue($self->isTextPresent("The tag '$tagName' has been saved."));
   }
 
-  // CRM-6586
+  /**
+   * CRM-6586
+   */
   public function testContactSearchExport() {
     $this->webtestLogin();
 

diff --git a/tests/phpunit/WebTest/Contribute/ContributionPageAddTest.php b/tests/phpunit/WebTest/Contribute/ContributionPageAddTest.php
index 09bd4a5879c8ff8106d9d0250a7e32d3768ca4c5..362b31a3a4fecd3229a41dc77e43a200d4a6981f 100644 (file)
--- a/tests/phpunit/WebTest/Contribute/ContributionPageAddTest.php
+++ b/tests/phpunit/WebTest/Contribute/ContributionPageAddTest.php
@@ -85,7 +85,9 @@ class WebTest_Contribute_ContributionPageAddTest extends CiviSeleniumTestCase {
     $this->isElementPresent("xpath=//div[@class='content other_amount-content']/input");
   }
 
-  // CRM-12510 Test copy contribution page
+  /**
+   * CRM-12510 Test copy contribution page
+   */
   public function testContributionPageCopy() {
     // open browser, login
     $this->webtestLogin();

diff --git a/tests/phpunit/WebTest/Event/AdditionalPaymentTest.php b/tests/phpunit/WebTest/Event/AdditionalPaymentTest.php
index b67ae2370d3ba9d4517f55d2548bd1ee68dccc81..651be44951cc5e58b1f49e6d1a9d7576bda1b3d2 100644 (file)
--- a/tests/phpunit/WebTest/Event/AdditionalPaymentTest.php
+++ b/tests/phpunit/WebTest/Event/AdditionalPaymentTest.php
@@ -34,7 +34,9 @@ class WebTest_Event_AdditionalPaymentTest extends CiviSeleniumTestCase {
     parent::setUp();
   }
 
-  // CRM-13964 and CRM-13965
+  /**
+   * CRM-13964 and CRM-13965
+   */
   public function testParticipantParitalPaymentInitiation() {
     // Log in using webtestLogin() method
     $this->webtestLogin();

diff --git a/tests/phpunit/WebTest/Event/MultipleEventRegistrationbyCartTest.php b/tests/phpunit/WebTest/Event/MultipleEventRegistrationbyCartTest.php
index 6d2384e4a6b0b2bf75406b7751e1273315895f2d..fe5c4c97d1651074be31c0f2266a0ab206e80256 100755 (executable)
--- a/tests/phpunit/WebTest/Event/MultipleEventRegistrationbyCartTest.php
+++ b/tests/phpunit/WebTest/Event/MultipleEventRegistrationbyCartTest.php
@@ -35,7 +35,9 @@ class WebTest_Event_MultipleEventRegistrationbyCartTest extends CiviSeleniumTest
     parent::setUp();
   }
 
-  // this functionality is broken hence skipping the test
+  /**
+   * this functionality is broken hence skipping the test
+   */
   public function skiptestAuthenticatedMultipleEvent() {
 
     // Log in using webtestLogin() method
@@ -128,7 +130,9 @@ class WebTest_Event_MultipleEventRegistrationbyCartTest extends CiviSeleniumTest
     $this->_checkContributionsandEventRegistration($value[0], $value[1], $events);
   }
 
-  // this functionality is broken hence skipping the test
+  /**
+   * this functionality is broken hence skipping the test
+   */
   public function skiptestAnonymousMultipleEvent() {
     // This is the path where our testing install resides.
     // The rest of URL is defined in CiviSeleniumTestCase base class, in