Fix comment block for variable declarations

Per civicrm/coder#7
civicrm · May 23, 2019 · 913ef7c · 913ef7c
1 parent c55429d
commit 913ef7c
Show file tree

Hide file tree

Showing 25 changed files with 90 additions and 67 deletions.
diff --git a/CRM/Contact/BAO/Query.php b/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;
 

diff --git a/CRM/Contact/Form/Search.php b/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;
 

diff --git a/CRM/Contact/Import/Parser.php b/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;

diff --git a/CRM/Contribute/Form/Contribution.php b/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;
 

diff --git a/CRM/Contribute/Form/ContributionBase.php b/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;
 

diff --git a/CRM/Core/Action.php b/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,

diff --git a/CRM/Custom/Import/Parser.php b/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;

diff --git a/CRM/Event/Form/ManageEvent.php b/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;
 

diff --git a/CRM/Event/Form/Registration/Register.php b/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;
 

diff --git a/CRM/Event/Import/Parser.php b/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;

diff --git a/CRM/Financial/Form/Payment.php b/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 = '';
 

diff --git a/CRM/Mailing/Page/View.php b/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;
 

diff --git a/CRM/Member/Import/Parser.php b/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

diff --git a/CRM/Report/Form.php b/CRM/Report/Form.php
@@ -49,14 +49,14 @@ class CRM_Report_Form extends CRM_Core_Form {
   /**
    * The id of the report instance
    *
-   * @var integer
+   * @var int
    */
   protected $_id;
 
   /**
    * The id of the report template
    *
-   * @var integer;
+   * @var int
    */
   protected $_templateID;
 
@@ -280,14 +280,15 @@ class CRM_Report_Form extends CRM_Core_Form {
    * when $_output mode is not 'html' or 'group' so as not to have to interpret / mess with that part
    * of the code (see limit() fn.
    *
-   * @var integer
+   * @var int
    */
   protected $_limitValue = NULL;
 
   /**
    * This can be set to specify row offset
    * See notes on _limitValue
-   * @var integer
+   *
+   * @var int
    */
   protected $_offsetValue = NULL;
   /**

diff --git a/CRM/SMS/Message.php b/CRM/SMS/Message.php
@@ -28,39 +28,45 @@
 class CRM_SMS_Message {
 
   /**
-   * @var String
    * What address is this SMS message coming from.
+   *
+   * @var string
    */
   public $from = '';
 
 
   /**
-   * @var String
    * What address is this SMS message going to.
+   *
+   * @var string
    */
   public $to = '';
 
   /**
-   * @var Integer
-   * Contact ID that is matched to the From address
+   * Contact ID that is matched to the From address.
+   *
+   * @var int
    */
   public $fromContactID = NULL;
 
   /**
-   * @var Integer
-   * Contact ID that is matched to the To address
+   * Contact ID that is matched to the To address.
+   *
+   * @var int
    */
   public $toContactID = NULL;
 
   /**
-   * @var String
-   * Body content of the message
+   * Body content of the message.
+   *
+   * @var string
    */
   public $body = '';
 
   /**
-   * @var Integer
-   * Trackable ID in the system to match to
+   * Trackable ID in the system to match to.
+   *
+   * @var int
    */
   public $trackID = NULL;
 

diff --git a/Civi/Angular/Page/Main.php b/Civi/Angular/Page/Main.php
@@ -37,7 +37,7 @@ class Main extends \CRM_Core_Page {
   /**
    * The region of the page into which JavaScript will be loaded.
    *
-   * @var String
+   * @var string
    * @deprecated
    */
   public $region;

diff --git a/tests/phpunit/CRM/Batch/Form/EntryTest.php b/tests/phpunit/CRM/Batch/Form/EntryTest.php
@@ -34,36 +34,42 @@ class CRM_Batch_Form_EntryTest extends CiviUnitTestCase {
 
   /**
    * Membership type name used in test function.
-   * @var String
+   *
+   * @var string
    */
   protected $_membershipTypeName = NULL;
 
   /**
    * Membership type id used in test function.
-   * @var String
+   *
+   * @var string
    */
   protected $_membershipTypeID = NULL;
 
   /**
    * Contact id used in test function.
-   * @var String
+   *
+   * @var string
    */
   protected $_contactID = NULL;
   /**
    * Contact id used in test function.
-   * @var String
+   *
+   * @var string
    */
   protected $_contactID2 = NULL;
 
   /**
    * Contact id used in test function.
-   * @var String
+   *
+   * @var string
    */
   protected $_contactID3 = NULL;
 
   /**
    * Contact id used in test function.
-   * @var String
+   *
+   * @var string
    */
   protected $_contactID4 = NULL;
 

diff --git a/tests/phpunit/CRM/Contact/BAO/QueryTestDataProvider.php b/tests/phpunit/CRM/Contact/BAO/QueryTestDataProvider.php
@@ -38,7 +38,9 @@
 class CRM_Contact_BAO_QueryTestDataProvider implements Iterator {
 
   /**
-   * @var integer
+   * Current count.
+   *
+   * @var int
    */
   private $i = 0;
 

diff --git a/tests/phpunit/CRM/Contact/Form/Search/Custom/GroupTestDataProvider.php b/tests/phpunit/CRM/Contact/Form/Search/Custom/GroupTestDataProvider.php
@@ -37,7 +37,9 @@
 class CRM_Contact_Form_Search_Custom_GroupTestDataProvider implements Iterator {
 
   /**
-   * @var integer
+   * Current count.
+   *
+   * @var int
    */
   private $i = 0;
 

diff --git a/tests/phpunit/CRM/Contact/Form/Search/Custom/SampleTestDataProvider.php b/tests/phpunit/CRM/Contact/Form/Search/Custom/SampleTestDataProvider.php
@@ -33,7 +33,9 @@
 class CRM_Contact_Form_Search_Custom_SampleTestDataProvider implements Iterator {
 
   /**
-   * @var integer
+   * Current count.
+   *
+   * @var int
    */
   private $i = 0;
 

diff --git a/tests/phpunit/CRM/Group/Page/AjaxTest.php b/tests/phpunit/CRM/Group/Page/AjaxTest.php
@@ -7,8 +7,9 @@
 class CRM_Group_Page_AjaxTest extends CiviUnitTestCase {
   /**
    * Permissioned group is used both as an active group the contact can see and as a group that allows
-   * logged in user to see contacts
-   * @var integer
+   * logged in user to see contacts.
+   *
+   * @var int
    */
   protected $_permissionedGroup;
   /**

diff --git a/tests/phpunit/CRM/Mailing/BAO/QueryTestDataProvider.php b/tests/phpunit/CRM/Mailing/BAO/QueryTestDataProvider.php
@@ -8,7 +8,7 @@
 class CRM_Mailing_BAO_QueryTestDataProvider implements Iterator {
 
   /**
-   * @var integer
+   * @var int
    */
   private $i = 0;