[NFC] Fix comment block for variable declarations

CRM/Contact/BAO/Query.php

@@ -409,8 +409,9 @@ class CRM_Contact_BAO_Query {
   protected $_relationshipValuesAdded = FALSE;
 
   /**
-   * Set to the name of the temp table if one has been created
-   * @var String
+   * Set to the name of the temp table if one has been created.
+   *
+   * @var string
    */
   public static $_relationshipTempTable = NULL;
 

CRM/Contact/Form/Search.php

@@ -120,7 +120,7 @@ class CRM_Contact_Form_Search extends CRM_Core_Form_Search {
   /**
    * The profile group id used for display.
    *
-   * @var integer
+   * @var int
    */
   protected $_ufGroupID;
 
@@ -132,13 +132,16 @@ class CRM_Contact_Form_Search extends CRM_Core_Form_Search {
   public static $csv = ['contact_type', 'group', 'tag'];
 
   /**
-   * @var string how to display the results. Should we display as
-   *             contributons, members, cases etc
+   * How to display the results. Should we display as contributons, members, cases etc.
+   *
+   * @var string
    */
   protected $_componentMode;
 
   /**
-   * @var string what operator should we use, AND or OR
+   * What operator should we use, AND or OR.
+   *
+   * @var string
    */
   protected $_operator;
 

CRM/Contact/Form/Search/Custom/FullText.php

@@ -35,7 +35,7 @@ class CRM_Contact_Form_Search_Custom_FullText extends CRM_Contact_Form_Search_Cu
   const LIMIT = 10;
 
   /**
-   * @var array CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery
+   * @var CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery[]
    */
   protected $_partialQueries = NULL;
 
@@ -54,23 +54,37 @@ class CRM_Contact_Form_Search_Custom_FullText extends CRM_Contact_Form_Search_Cu
   protected $_tableFields = NULL;
 
   /**
-   * @var array|null NULL if no limit; or array(0 => $limit, 1 => $offset)
+   * Limit clause.
+   *
+   * NULL if no limit; or array(0 => $limit, 1 => $offset).
+   *
+   * @var array|null
    */
   protected $_limitClause = NULL;
 
   /**
-   * @var array|null NULL if no limit; or array(0 => $limit, 1 => $offset)
+   * Limit row clause.
+   *
+   * NULL if no limit; or array(0 => $limit, 1 => $offset)
+   *
+   * @var array|null
    */
   protected $_limitRowClause = NULL;
 
   /**
-   * @var array|null NULL if no limit; or array(0 => $limit, 1 => $offset)
+   * Limit detail clause.
+   *
+   * NULL if no limit; or array(0 => $limit, 1 => $offset).
+   *
+   * @var array|null
    */
   protected $_limitDetailClause = NULL;
 
   protected $_limitNumber = 10;
+
   /**
-   * this should be one more than self::LIMIT
+   * This should be one more than self::LIMIT.
+   *
    * @var int
    */
   protected $_limitNumberPlus1 = 11;

CRM/Contact/Form/Search/Custom/Group.php

@@ -153,11 +153,12 @@ public function buildForm(&$form) {
   /**
    * @param int $offset
    * @param int $rowcount
-   * @param NULL $sort
+   * @param string $sort
    * @param bool $includeContactIDs
    * @param bool $justIDs
    *
    * @return string
+   * @throws \Exception
    */
   public function all(
     $offset = 0, $rowcount = 0, $sort = NULL,
@@ -587,10 +588,11 @@ public function count() {
   /**
    * @param int $offset
    * @param int $rowcount
-   * @param NULL $sort
+   * @param string $sort
    * @param bool $returnSQL
    *
    * @return string
+   * @throws \Exception
    */
   public function contactIDs($offset = 0, $rowcount = 0, $sort = NULL, $returnSQL = FALSE) {
     return $this->all($offset, $rowcount, $sort, FALSE, TRUE);

CRM/Contact/Import/Parser.php

@@ -37,18 +37,20 @@ abstract class CRM_Contact_Import_Parser extends CRM_Import_Parser {
   /**
    * Total number of lines in file
    *
-   * @var integer
+   * @var int
    */
   protected $_rowCount;
 
   /**
    * Running total number of un-matched Contacts.
+   *
    * @var int
    */
   protected $_unMatchCount;
 
   /**
-   * Array of unmatched lines
+   * Array of unmatched lines.
+   *
    * @var array
    */
   protected $_unMatch;
@@ -1354,7 +1356,7 @@ protected function fillPrimary(&$params, $values, $entity, $contactID) {
           'return' => 'location_type_id',
           'contact_id' => $contactID,
           'is_primary' => 1,
-          'sequential' => 1
+          'sequential' => 1,
         ]);
       }
       $defaultLocationType = CRM_Core_BAO_LocationType::getDefault();

CRM/Contact/Page/ImageFile.php

@@ -32,7 +32,9 @@
  */
 class CRM_Contact_Page_ImageFile extends CRM_Core_Page {
   /**
-   * @var int Time to live (seconds).
+   * Time to live (seconds).
+   *
+   * @var int
    *
    * 12 hours: 12 * 60 * 60 = 43200
    */

CRM/Contact/Page/View/ContactSmartGroup.php

@@ -33,13 +33,14 @@
 class CRM_Contact_Page_View_ContactSmartGroup extends CRM_Core_Page {
 
   /**
-   * @var int contact id
+   * Contact id.
+   *
+   * @var int
    */
   public $_contactId;
 
   /**
-   * called when action is browse.
-   *
+   * Called when action is browse.
    */
   public function browse() {
     $in = CRM_Contact_BAO_GroupContact::getContactGroup($this->_contactId, 'Added');

CRM/Contribute/Form/Contribution.php

@@ -132,8 +132,9 @@ class CRM_Contribute_Form_Contribution extends CRM_Contribute_Form_AbstractEditP
   public $_fromEmails;
 
   /**
-   * ID of from email
-   * @var integer
+   * ID of from email.
+   *
+   * @var int
    */
   public $fromEmailId;
 
@@ -171,8 +172,9 @@ class CRM_Contribute_Form_Contribution extends CRM_Contribute_Form_AbstractEditP
   public $userEmail;
 
   /**
-   * Price set ID
-   * @var integer
+   * Price set ID.
+   *
+   * @var int
    */
   public $_priceSetId;
 

CRM/Contribute/Form/ContributionBase.php

@@ -118,7 +118,7 @@ class CRM_Contribute_Form_ContributionBase extends CRM_Core_Form {
   /**
    * Pcp id
    *
-   * @var integer
+   * @var int
    */
   public $_pcpId;
 

CRM/Core/Action.php

@@ -41,7 +41,7 @@ class CRM_Core_Action {
    * Different possible actions are defined here. Keep in sync with the
    * constant from CRM_Core_Form for various modes.
    *
-   * @var integer const
+   * @var int
    */
   const
     NONE = 0,

CRM/Custom/Import/Parser.php

@@ -37,12 +37,8 @@ abstract class CRM_Custom_Import_Parser extends CRM_Contact_Import_Parser {
   protected $_fileName;
 
   /**
-   * #@+
-   * @var integer
-   */
-
-  /**
-   * Imported file size
+   * Imported file size.
+   *
    * @var int
    */
   protected $_fileSize;

CRM/Event/Form/ManageEvent.php

@@ -65,8 +65,9 @@ class CRM_Event_Form_ManageEvent extends CRM_Core_Form {
   protected $_isTemplate = FALSE;
 
   /**
-   * Pre-populate fields based on this template event_id
-   * @var integer
+   * Pre-populate fields based on this template event_id.
+   *
+   * @var int
    */
   protected $_templateId;
 

CRM/Event/Form/Registration/Register.php

@@ -69,12 +69,14 @@ class CRM_Event_Form_Registration_Register extends CRM_Event_Form_Registration {
   /**
    * Show fee block or not.
    *
-   * @var bool determines if fee block should be shown or hidden
+   * @var bool
    */
   public $_noFees;
 
   /**
-   * @var array Fee Block
+   * Fee Block.
+   *
+   * @var array
    */
   public $_feeBlock;
 

CRM/Event/Import/Parser.php

@@ -37,24 +37,22 @@ abstract class CRM_Event_Import_Parser extends CRM_Import_Parser {
   protected $_fileName;
 
   /**
-   * #@+
-   * @var integer
-   */
-
-  /**
-   * Imported file size
+   * Imported file size.
+   *
    * @var int
    */
   protected $_fileSize;
 
   /**
-   * Seperator being used
+   * Separator being used.
+   *
    * @var string
    */
   protected $_seperator;
 
   /**
-   * Total number of lines in file
+   * Total number of lines in file.
+   *
    * @var int
    */
   protected $_lineCount;

CRM/Financial/Form/Payment.php

@@ -51,7 +51,7 @@ class CRM_Financial_Form_Payment extends CRM_Core_Form {
   public $isBackOffice = FALSE;
 
   /**
-   * @var String
+   * @var string
    */
   public $_formName = '';
 

CRM/Mailing/Page/View.php

@@ -37,7 +37,9 @@
 class CRM_Mailing_Page_View extends CRM_Core_Page {
 
   /**
-   * @var Signal to Flexmailer that this version of the class is usable.
+   * Signal to Flexmailer that this version of the class is usable.
+   *
+   * @var bool
    */
   const USES_MAILING_PREVIEW_API = 1;
 

CRM/Member/Import/Parser.php

@@ -36,11 +36,6 @@ abstract class CRM_Member_Import_Parser extends CRM_Import_Parser {
 
   protected $_fileName;
 
-  /**
-   * #@+
-   * @var integer
-   */
-
   /**
    * Imported file size
    * @var int