INFRA-132 - Comment format cleanup
authorColeman Watts <coleman@civicrm.org>
Mon, 12 Jan 2015 03:16:14 +0000 (22:16 -0500)
committerColeman Watts <coleman@civicrm.org>
Mon, 12 Jan 2015 03:16:14 +0000 (22:16 -0500)
CRM/Case/Selector/Search.php
CRM/Contact/BAO/ProximityQuery.php
CRM/Contact/Form/Search/Custom/ContributionAggregate.php
CRM/Contact/Selector.php
CRM/Contribute/Selector/Search.php
CRM/Core/Selector/Base.php
CRM/Event/Selector/Search.php
CRM/Grant/Selector/Search.php
CRM/Mailing/Selector/Search.php
CRM/Member/Selector/Search.php
CRM/Pledge/Selector/Search.php

index 78b5e75f21493fae575aa9ce8d544c26b5c8e076..01463d3f03e63e90cb1bda10a13e2318edb419e0 100644 (file)
@@ -412,12 +412,8 @@ class CRM_Case_Selector_Search extends CRM_Core_Selector_Base {
   }
 
   /**
-   * @return array
-   *   which contains an array of strings
+   * @inheritDoc
    */
-
-  // the current internationalisation is bad, but should more or less work
-  // for most of "European" languages
   public function getQILL() {
     return $this->_query->qill();
   }
index bf769928fe7cb7fafae006390f14013e0981dd9c..64a3e85e0a5a3132819583a1de357735a6c431eb 100644 (file)
@@ -70,18 +70,19 @@ class CRM_Contact_BAO_ProximityQuery {
     }
   }
 
-  /**
+  /*
    * Latitudes in all of U. S.: from -7.2 (American Samoa) to 70.5 (Alaska).
    * Latitudes in continental U. S.: from 24.6 (Florida) to 49.0 (Washington).
    * Average latitude of all U. S. zipcodes: 37.9.
    */
 
-  /*
-    /**
-     * Estimate the Earth's radius at a given latitude.
-     * Default to an approximate average radius for the United States.
-     */
-
+  /**
+   * Estimate the Earth's radius at a given latitude.
+   * Default to an approximate average radius for the United States.
+   *
+   * @param float $latitude
+   * @return float
+   */
   public static function earthRadius($latitude) {
     $lat = deg2rad($latitude);
 
@@ -93,6 +94,11 @@ class CRM_Contact_BAO_ProximityQuery {
   /**
    * Convert longitude and latitude to earth-centered earth-fixed coordinates.
    * X axis is 0 long, 0 lat; Y axis is 90 deg E; Z axis is north pole.
+   *
+   * @param float $longitude
+   * @param float $latitude
+   * @param float $height
+   * @return array
    */
   public static function earthXYZ($longitude, $latitude, $height = 0) {
     $long = deg2rad($longitude);
@@ -114,6 +120,10 @@ class CRM_Contact_BAO_ProximityQuery {
 
   /**
    * Convert a given angle to earth-surface distance.
+   *
+   * @param float $angle
+   * @param float $latitude
+   * @return float
    */
   public static function earthArcLength($angle, $latitude) {
     return deg2rad($angle) * self::earthRadius($latitude);
@@ -121,6 +131,11 @@ class CRM_Contact_BAO_ProximityQuery {
 
   /**
    * Estimate the min and max longitudes within $distance of a given location.
+   *
+   * @param float $longitude
+   * @param float $latitude
+   * @param float $distance
+   * @return array
    */
   public static function earthLongitudeRange($longitude, $latitude, $distance) {
     $long = deg2rad($longitude);
@@ -148,6 +163,11 @@ class CRM_Contact_BAO_ProximityQuery {
 
   /**
    * Estimate the min and max latitudes within $distance of a given location.
+   *
+   * @param float $longitude
+   * @param float $latitude
+   * @param float $distance
+   * @return array
    */
   public static function earthLatitudeRange($longitude, $latitude, $distance) {
     $long = deg2rad($longitude);
@@ -186,9 +206,9 @@ class CRM_Contact_BAO_ProximityQuery {
   }
 
   /**
-   * @param $latitude
-   * @param $longitude
-   * @param $distance
+   * @param float $longitude
+   * @param float $latitude
+   * @param float $distance
    * @param string $tablePrefix
    *
    * @return string
@@ -243,7 +263,7 @@ ACOS(
 
   /**
    * @param $query
-   * @param $values
+   * @param array $values
    *
    * @throws Exception
    */
@@ -352,7 +372,7 @@ ACOS(
   }
 
   /**
-   * @param $input
+   * @param array $input
    */
   public static function fixInputParams(&$input) {
     foreach ($input as $param) {
index 8a0422d77a3b1b8202e676937e05b77081f0e783..7c8e246f164565c3156a921f624f84805a10258b 100644 (file)
@@ -42,10 +42,8 @@ class CRM_Contact_Form_Search_Custom_ContributionAggregate implements CRM_Contac
    */
   public function __construct(&$formValues) {
     $this->_formValues = $formValues;
-    /**
-     * Define the columns for search result rows
-     */
 
+    // Define the columns for search result rows
     $this->_columns = array(
       ts('Contact ID') => 'contact_id',
       ts('Name') => 'sort_name',
@@ -99,6 +97,8 @@ class CRM_Contact_Form_Search_Custom_ContributionAggregate implements CRM_Contac
 
   /**
    * Define the smarty template used to layout the search form and results listings.
+   *
+   * @return string
    */
   public function templateFile() {
     return 'CRM/Contact/Form/Search/Custom/ContributionAggregate.tpl';
@@ -106,6 +106,14 @@ class CRM_Contact_Form_Search_Custom_ContributionAggregate implements CRM_Contac
 
   /**
    * Construct the search query
+   *
+   * @param int $offset
+   * @param int $rowcount
+   * @param string|object $sort
+   * @param bool $includeContactIDs
+   * @param bool $justIDs
+   *
+   * @return string
    */
   function all(
     $offset = 0, $rowcount = 0, $sort = NULL,
@@ -175,11 +183,9 @@ civicrm_contact AS contact_a
 ";
   }
 
-  /*
-      * WHERE clause is an array built from any required JOINS plus conditional filters based on search criteria field values
-      *
-      */
   /**
+   * WHERE clause is an array built from any required JOINS plus conditional filters based on search criteria field values
+   *
    * @param bool $includeContactIDs
    *
    * @return string
@@ -246,7 +252,7 @@ civicrm_contact AS contact_a
     return implode(' AND ', $clauses);
   }
 
-  /*
+  /**
    * Functions below generally don't need to be modified
    */
   public function count() {
index b870948a184e9f1680580b0862ab046317d416b0..1a739ebe3fa5b1d663704ac26197ba49a31fcd1e 100644 (file)
@@ -1098,18 +1098,8 @@ SELECT DISTINCT 'civicrm_contact', contact_a.id, contact_a.id, '$cacheKey', cont
   }
 
   /**
-   * Given the current formValues, gets the query in local
-   * language
-   *
-   * @param array (
-   * reference)   $formValues   submitted formValues
-   *
-   * @return array
-   *   which contains an array of strings
+   * @inheritDoc
    */
-
-  // the current internationalisation is bad, but should more or less work
-  // for most of "European" languages
   public function getQILL() {
     return $this->_query->qill();
   }
index 2a0a97d92aadcf63a4920c90f482e153a543d3db..26f99824403554ae5f6f6c609ee73b5978af3cff 100644 (file)
@@ -428,12 +428,8 @@ class CRM_Contribute_Selector_Search extends CRM_Core_Selector_Base implements C
   }
 
   /**
-   * @return array
-   *   which contains an array of strings
+   * @inheritDoc
    */
-
-  // the current internationalisation is bad, but should more or less work
-  // for most of "European" languages
   public function getQILL() {
     return $this->_query->qill();
   }
index 8f1ec0a27c12fcb2f84509198213dd6eadbf1c90..1674ec58734cff762fe73c0ef4c92a2db316e116 100644 (file)
@@ -159,7 +159,11 @@ class CRM_Core_Selector_Base {
    * Get the display text in plain language for the search
    * to display on the results page
    *
-   * @return string
+   * FIXME: the current internationalisation is bad, but should more or less work
+   * on most of "European" languages
+   *
+   * @return array
+   *   array of strings
    */
   public function getQill() {
     return NULL;
index 0f05141ec37a7e7be334c3c983dde91922cc01ff..954382d579d4466ee64f077ad4c447c624e2e615 100644 (file)
@@ -428,11 +428,7 @@ class CRM_Event_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co
   }
 
   /**
-   * FIXME: the current internationalisation is bad, but should more or less work
-   * on most of "European" languages
-   *
-   * @return array
-   *   which contains an array of strings
+   * @inheritDoc
    */
   public function getQILL() {
     return $this->_query->qill();
index 234e81c688538a9e5c8a9df2f2fe40dc85423874..f1e532cb6e37753734802bba8ad33d1fd02a1fe0 100644 (file)
@@ -332,12 +332,8 @@ class CRM_Grant_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co
   }
 
   /**
-   * @return array
-   *   which contains an array of strings
+   * @inheritDoc
    */
-
-  // the current internationalisation is bad, but should more or less work
-  // for most of "European" languages
   public function getQILL() {
     return $this->_query->qill();
   }
index 7df147683145618f5a9e2fb30489f6ce205b7651..8865f2a7306562f10ebeab675377cfadc76d5a42 100644 (file)
@@ -328,12 +328,8 @@ class CRM_Mailing_Selector_Search extends CRM_Core_Selector_Base implements CRM_
   }
 
   /**
-   * @return array
-   *   which contains an array of strings
+   * @inheritDoc
    */
-
-  // the current internationalisation is bad, but should more or less work
-  // for most of "European" languages
   public function getQILL() {
     return $this->_query->qill();
   }
index 03daae4bcb8729a91a2d01128b3f2b6942ad86e0..e4927871bd31c6df19274992b3984a9ccd6dabcd 100644 (file)
@@ -451,12 +451,8 @@ class CRM_Member_Selector_Search extends CRM_Core_Selector_Base implements CRM_C
   }
 
   /**
-   * @return array
-   *   which contains an array of strings
+   * @inheritDoc
    */
-
-  // the current internationalisation is bad, but should more or less work
-  // for most of "European" languages
   public function getQILL() {
     return $this->_query->qill();
   }
index 133d2c260e0e5cd9eeb2150e4a015ab83a7ff2f0..f6c4040db18ef3322ed912faf2f4780a07d61c6a 100644 (file)
@@ -366,12 +366,8 @@ class CRM_Pledge_Selector_Search extends CRM_Core_Selector_Base {
   }
 
   /**
-   * @return array
-   *   which contains an array of strings
+   * @inheritDoc
    */
-
-  // the current internationalisation is bad, but should more or less work
-  // for most of "European" languages
   public function getQILL() {
     return $this->_query->qill();
   }