From: Tim Otten <totten@civicrm.org>
Date: Tue, 6 Jan 2015 19:41:10 +0000 (-0800)
Subject: INFRA-132 - CRM/Upgrade - Convert single-line @param to multi-line
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=c68f8bfa6acfa6fdb3704d1fd4d9aeae004881e4;p=civicrm-core.git

INFRA-132 - CRM/Upgrade - Convert single-line @param to multi-line
---

diff --git a/CRM/Upgrade/Form.php b/CRM/Upgrade/Form.php
index 44256e2e51..05f578c7d8 100644
--- a/CRM/Upgrade/Form.php
+++ b/CRM/Upgrade/Form.php
@@ -82,10 +82,13 @@ class CRM_Upgrade_Form extends CRM_Core_Form {
    * We should not use QuickForm directly. This class provides a lot
    * of default convenient functions, rules and buttons
    *
-   * @param object $state State associated with this form
+   * @param object $state
+   *   State associated with this form.
    * @param \const|\enum $action The mode the form is operating in (None/Create/View/Update/Delete)
-   * @param string $method The type of http method used (GET/POST)
-   * @param string $name The name of the form if different from class name
+   * @param string $method
+   *   The type of http method used (GET/POST).
+   * @param string $name
+   *   The name of the form if different from class name.
    *
    * @return \CRM_Core_Form
   @access public
@@ -545,9 +548,12 @@ SET    version = '$version'
   /**
    * Fill the queue with upgrade tasks
    *
-   * @param $currentVer string, the original revision
-   * @param $latestVer string, the target (final) revision
-   * @param $postUpgradeMessageFile string, path of a modifiable file which lists the post-upgrade messages
+   * @param $currentVer
+   *   String, the original revision.
+   * @param $latestVer
+   *   String, the target (final) revision.
+   * @param $postUpgradeMessageFile
+   *   String, path of a modifiable file which lists the post-upgrade messages.
    *
    * @return CRM_Queue
    */
@@ -610,7 +616,8 @@ SET    version = '$version'
    * Perform an incremental version update
    *
    * @param CRM_Queue_TaskContext $ctx
-   * @param $rev string, the target (intermediate) revision e.g '3.2.alpha1'
+   * @param $rev
+   *   String, the target (intermediate) revision e.g '3.2.alpha1'.
    *
    * @return bool
    */
@@ -628,10 +635,14 @@ SET    version = '$version'
    * Perform an incremental version update
    *
    * @param CRM_Queue_TaskContext $ctx
-   * @param $rev string, the target (intermediate) revision e.g '3.2.alpha1'
-   * @param $originalVer string, the original revision
-   * @param $latestVer string, the target (final) revision
-   * @param $postUpgradeMessageFile string, path of a modifiable file which lists the post-upgrade messages
+   * @param $rev
+   *   String, the target (intermediate) revision e.g '3.2.alpha1'.
+   * @param $originalVer
+   *   String, the original revision.
+   * @param $latestVer
+   *   String, the target (final) revision.
+   * @param $postUpgradeMessageFile
+   *   String, path of a modifiable file which lists the post-upgrade messages.
    *
    * @return bool
    */
@@ -688,10 +699,14 @@ SET    version = '$version'
    * Perform an incremental version update
    *
    * @param CRM_Queue_TaskContext $ctx
-   * @param $rev string, the target (intermediate) revision e.g '3.2.alpha1'
-   * @param $currentVer string, the original revision
-   * @param $latestVer string, the target (final) revision
-   * @param $postUpgradeMessageFile string, path of a modifiable file which lists the post-upgrade messages
+   * @param $rev
+   *   String, the target (intermediate) revision e.g '3.2.alpha1'.
+   * @param $currentVer
+   *   String, the original revision.
+   * @param $latestVer
+   *   String, the target (final) revision.
+   * @param $postUpgradeMessageFile
+   *   String, path of a modifiable file which lists the post-upgrade messages.
    *
    * @return bool
    */
@@ -735,7 +750,8 @@ SET    version = '$version'
    * by calling the 'setPreUpgradeMessage' on each incremental upgrade
    * object.
    *
-   * @param $preUpgradeMessage string, alterable
+   * @param $preUpgradeMessage
+   *   String, alterable.
    * @param $currentVer
    * @param $latestVer
    */
diff --git a/CRM/Upgrade/Incremental/Legacy.php b/CRM/Upgrade/Incremental/Legacy.php
index d27e6913b9..08d16de2f9 100644
--- a/CRM/Upgrade/Incremental/Legacy.php
+++ b/CRM/Upgrade/Incremental/Legacy.php
@@ -42,7 +42,8 @@ class CRM_Upgrade_Incremental_Legacy {
   /**
    * Compute any messages which should be displayed before upgrade
    *
-   * @param $preUpgradeMessage string, alterable
+   * @param $preUpgradeMessage
+   *   String, alterable.
    * @param $currentVer
    * @param $latestVer
    */
@@ -203,8 +204,10 @@ SELECT  id
   /**
    * Compute any messages which should be displayed after upgrade
    *
-   * @param $postUpgradeMessage string, alterable
-   * @param $rev string, an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs
+   * @param $postUpgradeMessage
+   *   String, alterable.
+   * @param $rev
+   *   String, an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs.
    * @return void
    */
   public static function setPostUpgradeMessage(&$postUpgradeMessage, $rev) {
@@ -268,7 +271,8 @@ SELECT  count( id ) as statusCount
   /**
    * Perform an incremental upgrade
    *
-   * @param $rev string, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final)
+   * @param $rev
+   *   String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
    */
   public static function upgrade_2_2_alpha1($rev) {
     for ($stepID = 1; $stepID <= 4; $stepID++) {
@@ -312,7 +316,8 @@ SELECT  count( id ) as statusCount
   /**
    * Perform an incremental upgrade
    *
-   * @param $rev string, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final)
+   * @param $rev
+   *   String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
    */
   public static function upgrade_2_1_2($rev) {
     $formName = "CRM_Upgrade_TwoOne_Form_TwoOneTwo";
@@ -353,7 +358,8 @@ SELECT  count( id ) as statusCount
   /**
    * Perform an incremental upgrade
    *
-   * @param $rev string, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final)
+   * @param $rev
+   *   String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
    */
   public static function upgrade_2_2_beta1($rev) {
     if (!CRM_Core_DAO::checkFieldExists('civicrm_pcp_block', 'notify_email')) {
@@ -367,7 +373,8 @@ SELECT  count( id ) as statusCount
   /**
    * Perform an incremental upgrade
    *
-   * @param $rev string, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final)
+   * @param $rev
+   *   String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
    */
   public static function upgrade_2_2_beta2($rev) {
     $template = CRM_Core_Smarty::singleton();
@@ -388,7 +395,8 @@ SELECT  count( id ) as statusCount
   /**
    * Perform an incremental upgrade
    *
-   * @param $rev string, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final)
+   * @param $rev
+   *   String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
    */
   public static function upgrade_2_2_beta3($rev) {
     $template = CRM_Core_Smarty::singleton();
@@ -403,7 +411,8 @@ SELECT  count( id ) as statusCount
   /**
    * Perform an incremental upgrade
    *
-   * @param $rev string, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final)
+   * @param $rev
+   *   String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
    */
   public static function upgrade_3_0_alpha1($rev) {
 
@@ -423,7 +432,8 @@ SELECT  count( id ) as statusCount
   /**
    * Perform an incremental upgrade
    *
-   * @param $rev string, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final)
+   * @param $rev
+   *   String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
    */
   public static function upgrade_3_1_alpha1($rev) {
 
@@ -443,7 +453,8 @@ SELECT  count( id ) as statusCount
   /**
    * Perform an incremental upgrade
    *
-   * @param $rev string, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final)
+   * @param $rev
+   *   String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
    */
   public static function upgrade_2_2_7($rev) {
     $upgrade = new CRM_Upgrade_Form();
@@ -475,7 +486,8 @@ SELECT  count( id ) as statusCount
   /**
    * Perform an incremental upgrade
    *
-   * @param $rev string, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final)
+   * @param $rev
+   *   String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
    */
   public static function upgrade_3_0_2($rev) {
 
@@ -497,7 +509,8 @@ SELECT  count( id ) as statusCount
   /**
    * Perform an incremental upgrade
    *
-   * @param $rev string, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final)
+   * @param $rev
+   *   String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
    */
   public static function upgrade_3_0_4($rev) {
     //make sure 'Deceased' membership status present in db,CRM-5636
@@ -517,7 +530,8 @@ SELECT  count( id ) as statusCount
   /**
    * Perform an incremental upgrade
    *
-   * @param $rev string, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final)
+   * @param $rev
+   *   String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
    */
   public static function upgrade_3_1_0($rev) {
     // upgrade all roles who have 'access CiviEvent' permission, to also have
@@ -545,7 +559,8 @@ SELECT  count( id ) as statusCount
   /**
    * Perform an incremental upgrade
    *
-   * @param $rev string, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final)
+   * @param $rev
+   *   String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
    */
   public static function upgrade_3_1_3($rev) {
     $threeOne = new CRM_Upgrade_ThreeOne_ThreeOne();
@@ -558,7 +573,8 @@ SELECT  count( id ) as statusCount
   /**
    * Perform an incremental upgrade
    *
-   * @param $rev string, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final)
+   * @param $rev
+   *   String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
    */
   public static function upgrade_3_1_4($rev) {
     $threeOne = new CRM_Upgrade_ThreeOne_ThreeOne();
diff --git a/CRM/Upgrade/Incremental/php/FourFive.php b/CRM/Upgrade/Incremental/php/FourFive.php
index a94ec64cf5..c184955ffa 100644
--- a/CRM/Upgrade/Incremental/php/FourFive.php
+++ b/CRM/Upgrade/Incremental/php/FourFive.php
@@ -50,7 +50,8 @@ class CRM_Upgrade_Incremental_php_FourFive {
    * revision to the database.
    *
    * @param $preUpgradeMessage
-   * @param $rev string, a version number, e.g. '4.4.alpha1', '4.4.beta3', '4.4.0'
+   * @param $rev
+   *   String, a version number, e.g. '4.4.alpha1', '4.4.beta3', '4.4.0'.
    * @param null $currentVer
    *
    * @return void
@@ -61,8 +62,10 @@ class CRM_Upgrade_Incremental_php_FourFive {
   /**
    * Compute any messages which should be displayed after upgrade
    *
-   * @param $postUpgradeMessage string, alterable
-   * @param $rev string, an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs
+   * @param $postUpgradeMessage
+   *   String, alterable.
+   * @param $rev
+   *   String, an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs.
    * @return void
    */
   public function setPostUpgradeMessage(&$postUpgradeMessage, $rev) {
@@ -150,8 +153,10 @@ DROP KEY `{$dao->CONSTRAINT_NAME}`";
    *
    *
    * @param CRM_Queue_TaskContext $ctx
-   * @param $startId int, the first/lowest entity ID to convert
-   * @param $endId int, the last/highest entity ID to convert
+   * @param $startId
+   *   Int, the first/lowest entity ID to convert.
+   * @param $endId
+   *   Int, the last/highest entity ID to convert.
    * @param
    *
    * @return bool
diff --git a/CRM/Upgrade/Incremental/php/FourFour.php b/CRM/Upgrade/Incremental/php/FourFour.php
index 1c6b710a68..18e7a6800e 100644
--- a/CRM/Upgrade/Incremental/php/FourFour.php
+++ b/CRM/Upgrade/Incremental/php/FourFour.php
@@ -52,7 +52,8 @@ class CRM_Upgrade_Incremental_php_FourFour {
    * revision to the database.
    *
    * @param $preUpgradeMessage
-   * @param $rev string, a version number, e.g. '4.4.alpha1', '4.4.beta3', '4.4.0'
+   * @param $rev
+   *   String, a version number, e.g. '4.4.alpha1', '4.4.beta3', '4.4.0'.
    * @param null $currentVer
    *
    * @return void
@@ -77,8 +78,10 @@ class CRM_Upgrade_Incremental_php_FourFour {
   /**
    * Compute any messages which should be displayed after upgrade
    *
-   * @param $postUpgradeMessage string, alterable
-   * @param $rev string, an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs
+   * @param $postUpgradeMessage
+   *   String, alterable.
+   * @param $rev
+   *   String, an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs.
    * @return void
    */
   public function setPostUpgradeMessage(&$postUpgradeMessage, $rev) {
@@ -715,7 +718,8 @@ CREATE TABLE IF NOT EXISTS `civicrm_word_replacement` (
    * However, if there's a bug in here prior to 4.4.0, we should apply the
    * bugfix in both places.
    *
-   * @param bool $rebuildEach whether to perform rebuild after each individual API call
+   * @param bool $rebuildEach
+   *   Whether to perform rebuild after each individual API call.
    * @return array Each item is $params for WordReplacement.create
    * @see CRM_Core_BAO_WordReplacement::convertConfigArraysToAPIParams
    */
diff --git a/CRM/Upgrade/Incremental/php/FourOne.php b/CRM/Upgrade/Incremental/php/FourOne.php
index 6e899686e6..d6fb34a6b2 100644
--- a/CRM/Upgrade/Incremental/php/FourOne.php
+++ b/CRM/Upgrade/Incremental/php/FourOne.php
@@ -56,8 +56,10 @@ class CRM_Upgrade_Incremental_php_FourOne {
   /**
    * Compute any messages which should be displayed after upgrade
    *
-   * @param $postUpgradeMessage string, alterable
-   * @param $rev string, an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs
+   * @param $postUpgradeMessage
+   *   String, alterable.
+   * @param $rev
+   *   String, an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs.
    *
    * @return void
    */
diff --git a/CRM/Upgrade/Incremental/php/FourSix.php b/CRM/Upgrade/Incremental/php/FourSix.php
index ece18192ae..1b28b7e31c 100644
--- a/CRM/Upgrade/Incremental/php/FourSix.php
+++ b/CRM/Upgrade/Incremental/php/FourSix.php
@@ -50,7 +50,8 @@ class CRM_Upgrade_Incremental_php_FourSix {
    * revision to the database.
    *
    * @param $preUpgradeMessage
-   * @param $rev string, a version number, e.g. '4.4.alpha1', '4.4.beta3', '4.4.0'
+   * @param $rev
+   *   String, a version number, e.g. '4.4.alpha1', '4.4.beta3', '4.4.0'.
    * @param null $currentVer
    *
    * @return void
@@ -61,8 +62,10 @@ class CRM_Upgrade_Incremental_php_FourSix {
   /**
    * Compute any messages which should be displayed after upgrade
    *
-   * @param $postUpgradeMessage string, alterable
-   * @param $rev string, an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs
+   * @param $postUpgradeMessage
+   *   String, alterable.
+   * @param $rev
+   *   String, an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs.
    * @return void
    */
   public function setPostUpgradeMessage(&$postUpgradeMessage, $rev) {
diff --git a/CRM/Upgrade/Incremental/php/FourThree.php b/CRM/Upgrade/Incremental/php/FourThree.php
index 9ddd537d42..619dd36183 100644
--- a/CRM/Upgrade/Incremental/php/FourThree.php
+++ b/CRM/Upgrade/Incremental/php/FourThree.php
@@ -51,7 +51,8 @@ class CRM_Upgrade_Incremental_php_FourThree {
    * revision to the database.
    *
    * @param $preUpgradeMessage
-   * @param $rev string, a version number, e.g. '4.3.alpha1', '4.3.beta3', '4.3.0'
+   * @param $rev
+   *   String, a version number, e.g. '4.3.alpha1', '4.3.beta3', '4.3.0'.
    * @param null $currentVer
    *
    * @return void|bool
@@ -114,8 +115,10 @@ WHERE {$key}.id IS NULL";
   /**
    * Compute any messages which should be displayed after upgrade
    *
-   * @param $postUpgradeMessage string, alterable
-   * @param $rev string, an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs
+   * @param $postUpgradeMessage
+   *   String, alterable.
+   * @param $rev
+   *   String, an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs.
    * @return void
    */
   public function setPostUpgradeMessage(&$postUpgradeMessage, $rev) {
diff --git a/CRM/Upgrade/Incremental/php/FourTwo.php b/CRM/Upgrade/Incremental/php/FourTwo.php
index 3dc6f96b35..d4725328ff 100644
--- a/CRM/Upgrade/Incremental/php/FourTwo.php
+++ b/CRM/Upgrade/Incremental/php/FourTwo.php
@@ -53,7 +53,8 @@ class CRM_Upgrade_Incremental_php_FourTwo {
    * revision to the database.
    *
    * @param $preUpgradeMessage
-   * @param $rev string, a version number, e.g. '4.2.alpha1', '4.2.beta3', '4.2.0'
+   * @param $rev
+   *   String, a version number, e.g. '4.2.alpha1', '4.2.beta3', '4.2.0'.
    * @param null $currentVer
    *
    * @return void
@@ -146,8 +147,10 @@ INNER JOIN civicrm_price_set cps ON cps.id = cpf.price_set_id AND cps.name <>'de
   /**
    * Compute any messages which should be displayed after upgrade
    *
-   * @param $postUpgradeMessage string, alterable
-   * @param $rev string, an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs
+   * @param $postUpgradeMessage
+   *   String, alterable.
+   * @param $rev
+   *   String, an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs.
    * @return void
    */
   public function setPostUpgradeMessage(&$postUpgradeMessage, $rev) {
@@ -587,8 +590,10 @@ WHERE     cpse.price_set_id IS NULL";
    * records.
    *
    * @param CRM_Queue_TaskContext $ctx
-   * @param $startId int, the first/lowest contribution ID to convert
-   * @param $endId int, the last/highest contribution ID to convert
+   * @param $startId
+   *   Int, the first/lowest contribution ID to convert.
+   * @param $endId
+   *   Int, the last/highest contribution ID to convert.
    *
    * @return bool
    */
@@ -733,8 +738,10 @@ WHERE     cpf.price_set_id = %1
    * records.
    *
    * @param CRM_Queue_TaskContext $ctx
-   * @param $startId int, the first/lowest participant ID to convert
-   * @param $endId int, the last/highest participant ID to convert
+   * @param $startId
+   *   Int, the first/lowest participant ID to convert.
+   * @param $endId
+   *   Int, the last/highest participant ID to convert.
    *
    * @return bool
    */
diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Field.php b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Field.php
index ded2d209fa..21108dc984 100644
--- a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Field.php
+++ b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Field.php
@@ -48,7 +48,8 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Field extends CRM_Upgrade_Snapshot_V4p
    * price field object. the params array could contain additional unused name/value
    * pairs
    *
-   * @param array $params (reference ) an assoc array of name/value pairs
+   * @param array $params
+   *   (reference ) an assoc array of name/value pairs.
    *
    * @return CRM_Upgrade_Snapshot_V4p2_Price_BAO_Field object
    * @static
@@ -71,7 +72,8 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Field extends CRM_Upgrade_Snapshot_V4p
    *
    * This function is invoked from within the web form layer and also from the api layer
    *
-   * @param array $params (reference) an assoc array of name/value pairs
+   * @param array $params
+   *   (reference) an assoc array of name/value pairs.
    *
    * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_Field object
    * @static
@@ -154,8 +156,10 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Field extends CRM_Upgrade_Snapshot_V4p
   /**
    * Fetch object based on array of properties
    *
-   * @param array $params   (reference ) an assoc array of name/value pairs
-   * @param array $defaults (reference ) an assoc array to hold the flattened values
+   * @param array $params
+   *   (reference ) an assoc array of name/value pairs.
+   * @param array $defaults
+   *   (reference ) an assoc array to hold the flattened values.
    *
    * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_Field object
    * @static
@@ -167,8 +171,10 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Field extends CRM_Upgrade_Snapshot_V4p
   /**
    * Update the is_active flag in the db
    *
-   * @param int      $id         Id of the database record
-   * @param boolean  $is_active  Value we want to set the is_active field
+   * @param int $id
+   *   Id of the database record.
+   * @param bool $is_active
+   *   Value we want to set the is_active field.
    *
    * @return   Object            DAO object on sucess, null otherwise
    *
@@ -181,7 +187,8 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Field extends CRM_Upgrade_Snapshot_V4p
   /**
    * Get the field title.
    *
-   * @param int $id id of field.
+   * @param int $id
+   *   Id of field.
    *
    * @return string name
    *
@@ -195,12 +202,16 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Field extends CRM_Upgrade_Snapshot_V4p
   /**
    * This function for building custom fields
    *
-   * @param CRM_Core_Form $qf form object (reference)
-   * @param string $elementName name of the custom field
+   * @param CRM_Core_Form $qf
+   *   Form object (reference).
+   * @param string $elementName
+   *   Name of the custom field.
    * @param int $fieldId
-   * @param boolean $inactiveNeeded
-   * @param boolean $useRequired true if required else false
-   * @param string $label label for custom field
+   * @param bool $inactiveNeeded
+   * @param bool $useRequired
+   *   True if required else false.
+   * @param string $label
+   *   Label for custom field.
    * @param null $fieldOptions
    * @param array $freezeOptions
    *
@@ -443,9 +454,12 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Field extends CRM_Upgrade_Snapshot_V4p
   /**
    * Retrieve a list of options for the specified field
    *
-   * @param int $fieldId price field ID
-   * @param bool $inactiveNeeded include inactive options
-   * @param bool $reset ignore stored values\
+   * @param int $fieldId
+   *   Price field ID.
+   * @param bool $inactiveNeeded
+   *   Include inactive options.
+   * @param bool $reset
+   *   Ignore stored values\.
    *
    * @return array array of options
    */
@@ -495,7 +509,8 @@ WHERE
   /**
    * Delete the price set field.
    *
-   * @param   int   $id    Field Id
+   * @param int $id
+   *   Field Id.
    *
    * @return  boolean
    *
@@ -541,7 +556,8 @@ WHERE
   /**
    * Validate the priceset
    *
-   * @param int $priceSetId , array $fields
+   * @param int $priceSetId
+   *   , array $fields.
    *
    * retrun the error string
    *
diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/FieldValue.php b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/FieldValue.php
index 69d5b35602..2346c90a16 100644
--- a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/FieldValue.php
+++ b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/FieldValue.php
@@ -42,7 +42,8 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_FieldValue extends CRM_Upgrade_Snapsho
   /**
    * Insert/update a new entry in the database.
    *
-   * @param array $params (reference), array $ids
+   * @param array $params
+   *   (reference), array $ids.
    *
    * @param $ids
    *
@@ -70,7 +71,8 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_FieldValue extends CRM_Upgrade_Snapsho
   /**
    * Creates a new entry in the database.
    *
-   * @param array $params (reference), array $ids
+   * @param array $params
+   *   (reference), array $ids.
    *
    * @param $ids
    *
@@ -111,8 +113,10 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_FieldValue extends CRM_Upgrade_Snapsho
    * Takes a bunch of params that are needed to match certain criteria and
    * retrieves the relevant objects.
    *
-   * @param array $params   (reference ) an assoc array
-   * @param array $defaults (reference ) an assoc array to hold the flattened values
+   * @param array $params
+   *   (reference ) an assoc array.
+   * @param array $defaults
+   *   (reference ) an assoc array to hold the flattened values.
    *
    * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue object
    * @static
@@ -124,9 +128,12 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_FieldValue extends CRM_Upgrade_Snapsho
   /**
    * Retrive the all values for given field id
    *
-   * @param int $fieldId price_field_id
-   * @param array $values (reference ) to hold the values
-   * @param string $orderBy for order by, default weight
+   * @param int $fieldId
+   *   Price_field_id.
+   * @param array $values
+   *   (reference ) to hold the values.
+   * @param string $orderBy
+   *   For order by, default weight.
    * @param bool|int $isActive is_active, default false
    *
    * @return array $values
@@ -152,7 +159,8 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_FieldValue extends CRM_Upgrade_Snapsho
   /**
    * Get the price field option label.
    *
-   * @param int $id id of field option.
+   * @param int $id
+   *   Id of field option.
    *
    * @return string name
    *
@@ -166,8 +174,10 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_FieldValue extends CRM_Upgrade_Snapsho
   /**
    * Update the is_active flag in the db
    *
-   * @param int      $id         Id of the database record
-   * @param boolean  $is_active  Value we want to set the is_active field
+   * @param int $id
+   *   Id of the database record.
+   * @param bool $is_active
+   *   Value we want to set the is_active field.
    *
    * @return   Object            DAO object on sucess, null otherwise
    *
@@ -180,7 +190,8 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_FieldValue extends CRM_Upgrade_Snapsho
   /**
    * Delete all values of the given field id
    *
-   * @param  int    $fieldId    Price field id
+   * @param int $fieldId
+   *   Price field id.
    *
    * @return boolean
    *
@@ -199,7 +210,8 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_FieldValue extends CRM_Upgrade_Snapsho
   /**
    * Delete the value.
    *
-   * @param   int   $id  Id
+   * @param int $id
+   *   Id.
    *
    * @return  boolean
    *
diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/LineItem.php b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/LineItem.php
index 0743bba66f..1f485c7be9 100644
--- a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/LineItem.php
+++ b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/LineItem.php
@@ -48,7 +48,8 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_LineItem extends CRM_Upgrade_Snapshot_
   /**
    * Creates a new entry in the database.
    *
-   * @param array $params (reference) an assoc array of name/value pairs
+   * @param array $params
+   *   (reference) an assoc array of name/value pairs.
    *
    * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_LineItem object
    * @static
@@ -74,8 +75,10 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_LineItem extends CRM_Upgrade_Snapshot_
    * price_field_id.  This is the inverse function of create.  It also
    * stores all of the retrieved values in the default array.
    *
-   * @param array $params   (reference ) an assoc array of name/value pairs
-   * @param array $defaults (reference ) an assoc array to hold the flattened values
+   * @param array $params
+   *   (reference ) an assoc array of name/value pairs.
+   * @param array $defaults
+   *   (reference ) an assoc array to hold the flattened values.
    *
    * @return CRM_Upgrade_Snapshot_V4p2_Price_BAO_LineItem object
    * @static
@@ -94,8 +97,10 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_LineItem extends CRM_Upgrade_Snapshot_
    * Given a participant id/contribution id,
    * return contribution/fee line items
    *
-   * @param $entityId  int    participant/contribution id
-   * @param $entity    string participant/contribution.
+   * @param $entityId
+   *   Int participant/contribution id.
+   * @param $entity
+   *   String participant/contribution.
    *
    * @param null $isQuick
    *
@@ -168,11 +173,15 @@ WHERE     %2.id = %1";
    * This method will create the lineItem array required for
    * processAmount method
    *
-   * @param  int   $fid       price set field id
-   * @param  array $params    reference to form values
-   * @param  array $fields    reference to array of fields belonging
+   * @param int $fid
+   *   Price set field id.
+   * @param array $params
+   *   Reference to form values.
+   * @param array $fields
+   *   Reference to array of fields belonging.
    *                          to the price set used for particular event
-   * @param  array $values    reference to the values array(
+   * @param array $values
+   *   Reference to the values array(.
      this is
    *                          lineItem array)
    *
diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php
index 2c6a4eceab..d124af498a 100644
--- a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php
+++ b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php
@@ -49,7 +49,8 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Set extends CRM_Upgrade_Snapshot_V4p2_
   /**
    * Takes an associative array and creates a price set object
    *
-   * @param array $params (reference) an assoc array of name/value pairs
+   * @param array $params
+   *   (reference) an assoc array of name/value pairs.
    *
    * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_Set object
    * @static
@@ -66,8 +67,10 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Set extends CRM_Upgrade_Snapshot_V4p2_
   /**
    * Fetch object based on array of properties
    *
-   * @param array $params   (reference ) an assoc array of name/value pairs
-   * @param array $defaults (reference ) an assoc array to hold the flattened values
+   * @param array $params
+   *   (reference ) an assoc array of name/value pairs.
+   * @param array $defaults
+   *   (reference ) an assoc array to hold the flattened values.
    *
    * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_Set object
    * @static
@@ -79,8 +82,10 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Set extends CRM_Upgrade_Snapshot_V4p2_
   /**
    * Update the is_active flag in the db
    *
-   * @param int $id id of the database record
-   * @param bool $isActive value we want to set the is_active field
+   * @param int $id
+   *   Id of the database record.
+   * @param bool $isActive
+   *   Value we want to set the is_active field.
    *
    * @return Object             DAO object on sucess, null otherwise
    * @static
@@ -132,7 +137,8 @@ WHERE       ps.name = '{$entityName}'
   /**
    * Get the price set title.
    *
-   * @param int $id   id of price set
+   * @param int $id
+   *   Id of price set.
    *
    * @return string   title
    *
@@ -146,7 +152,8 @@ WHERE       ps.name = '{$entityName}'
   /**
    * Return a list of all forms which use this price set.
    *
-   * @param int $id id of price set
+   * @param int $id
+   *   Id of price set.
    * @param bool|\str $simpleReturn - get raw data. Possible values: 'entity', 'table'
    *
    * @return array
@@ -247,7 +254,8 @@ WHERE     ct.id = cp.contribution_type_id AND
   /**
    * Delete the price set
    *
-   * @param int $id Price Set id
+   * @param int $id
+   *   Price Set id.
    *
    * @return boolean false if fields exist for this set, true if the
    * set could be deleted
@@ -286,8 +294,8 @@ WHERE     ct.id = cp.contribution_type_id AND
    * Link the price set with the specified table and id
    *
    * @param string $entityTable
-   * @param integer $entityId
-   * @param integer $priceSetId
+   * @param int $entityId
+   * @param int $priceSetId
    *
    * @return bool
    */
@@ -315,7 +323,7 @@ WHERE     ct.id = cp.contribution_type_id AND
    * Delete price set for the given entity and id
    *
    * @param string $entityTable
-   * @param integer $entityId
+   * @param int $entityId
    *
    * @return mixed
    */
@@ -332,7 +340,8 @@ WHERE     ct.id = cp.contribution_type_id AND
    *
    * @param string $entityTable
    * @param int $entityId
-   * @param int $usedFor ( price set that extends/used for particular component )
+   * @param int $usedFor
+   *   ( price set that extends/used for particular component ).
    *
    * @param null $isQuickConfig
    * @param null $setName
@@ -368,7 +377,8 @@ WHERE     ct.id = cp.contribution_type_id AND
   /**
    * Find a price_set_id associatied with the given option value or  field ID
    *
-   * @param array $params (reference) an assoc array of name/value pairs
+   * @param array $params
+   *   (reference) an assoc array of name/value pairs.
    *                      array may contain either option id or
    *                      price field id
    *
@@ -399,7 +409,8 @@ WHERE     ct.id = cp.contribution_type_id AND
   /**
    * Return an associative array of all price sets
    *
-   * @param bool $withInactive whether or not to include inactive entries
+   * @param bool $withInactive
+   *   Whether or not to include inactive entries.
    * @param bool|string $extendComponentName name of the component like 'CiviEvent','CiviContribute'
    *
    * @return array associative array of id => name
@@ -444,7 +455,8 @@ WHERE     ct.id = cp.contribution_type_id AND
    *
    * An array containing price set details (including price fields) is returned
    *
-   * @param int $setID price set id whose details are needed
+   * @param int $setID
+   *   Price set id whose details are needed.
    * @param bool $required
    * @param bool $validOnly
    *
@@ -907,7 +919,8 @@ return $var;
  * This function is to make a copy of a price set, including
  * all the fields
  *
- * @param int $id the price set id to copy
+ * @param int $id
+ *   The price set id to copy.
  *
  * @return the copy object
  * @static
@@ -953,7 +966,8 @@ return $copy;
   /**
    * This function is to check price set permission
    *
-   * @param int $sid the price set id
+   * @param int $sid
+   *   The price set id.
    *
    * @return bool
    */
@@ -973,7 +987,8 @@ return TRUE;
    * Get the sum of participant count
    * for all fields of given price set.
    *
-   * @param int $sid the price set id
+   * @param int $sid
+   *   The price set id.
    *
    * @param bool $onlyActive
    *
@@ -1034,7 +1049,8 @@ return $count;
 /**
  * Function to check if auto renew option should be shown
  *
- * @param int $priceSetId price set id
+ * @param int $priceSetId
+ *   Price set id.
  *
  * @return int $autoRenewOption ( 0:hide, 1:optional 2:required )
  */
@@ -1081,7 +1097,8 @@ return 0;
   /**
    * Retrieve auto renew frequency and interval
    *
-   * @param int $priceSetId price set id
+   * @param int $priceSetId
+   *   Price set id.
    *
    * @return array associate array of frequency interval and unit
    * @static
@@ -1112,8 +1129,10 @@ return 0;
   /**
    * Update the is_quick_config flag in the db
    *
-   * @param  int      $id             id of the database record
-   * @param  boolean  $isQuickConfig  value we want to set the is_quick_config field
+   * @param int $id
+   *   Id of the database record.
+   * @param boolean $isQuickConfig
+   *   Value we want to set the is_quick_config field.
    *
    * @return Object                   DAO object on sucess, null otherwise
    * @static
diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Field.php b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Field.php
index 510a8bbc27..211536a2df 100644
--- a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Field.php
+++ b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Field.php
@@ -406,8 +406,10 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_Field extends CRM_Core_DAO
     /**
      * returns a ts()-translated enum value for display purposes
      *
-     * @param string $field  the enum field in question
-     * @param string $value  the enum value up for translation
+     * @param string $field
+     *   The enum field in question.
+     * @param string $value
+     *   The enum value up for translation.
      *
      * @return string  the display value of the enum
      */
@@ -429,7 +431,8 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_Field extends CRM_Core_DAO
     /**
      * adds $value['foo_display'] for each $value['foo'] enum from civicrm_price_field
      *
-     * @param array $values (reference)  the array up for enhancing
+     * @param array $values
+     *   (reference) the array up for enhancing.
      * @return void
      */
     public static function addDisplayEnums(&$values)