[NFC] phpdoc cleanup

Fixes style elements that stricter phpcs picks up

diff --git a/CRM/Contribute/BAO/Contribution.php b/CRM/Contribute/BAO/Contribution.php
index bc6840e43b108b34bf0656134c1dbd7f99a1b9ff..6141caf4ab7a3cbf6542e6e6c511642c2fc87561 100644 (file)
--- a/CRM/Contribute/BAO/Contribution.php
+++ b/CRM/Contribute/BAO/Contribution.php
@@ -56,7 +56,7 @@ class CRM_Contribute_BAO_Contribution extends CRM_Contribute_DAO_Contribution {
   /**
    * Field for all the objects related to this contribution
    *
-   * @var array of objects (e.g membership object, participant object)
+   * @var \CRM_Member_BAO_Membership|\CRM_Event_BAO_Participant[]
    */
   public $_relatedObjects = [];
 
@@ -66,7 +66,7 @@ class CRM_Contribute_BAO_Contribution extends CRM_Contribute_DAO_Contribution {
    * This is used for composing messages because they have dependency on the
    * contribution_page or event page - although over time we may eliminate that
    *
-   * @var string component or event
+   * @var "contribution"\"event"
    */
   public $_component = NULL;
 
@@ -4330,10 +4330,10 @@ INNER JOIN civicrm_activity ON civicrm_activity_contact.activity_id = civicrm_ac
   /**
    * Check financial type validation on update of a contribution.
    *
-   * @param Integer $financialTypeId
+   * @param int $financialTypeId
    *   Value of latest Financial Type.
    *
-   * @param Integer $contributionId
+   * @param int $contributionId
    *   Contribution Id.
    *
    * @param array $errors
@@ -4923,15 +4923,15 @@ INNER JOIN civicrm_activity ON civicrm_activity_contact.activity_id = civicrm_ac
   }
 
   /**
-   * Function use to store line item proportionaly in
-   * in entity financial trxn table
+   * Function use to store line item proportionally in in entity financial trxn table
    *
    * @param array $trxnParams
    *
-   * @param Integer $trxnId
+   * @param int $trxnId
    *
    * @param float $contributionTotalAmount
    *
+   * @throws \CiviCRM_API3_Exception
    */
   public static function assignProportionalLineItems($trxnParams, $trxnId, $contributionTotalAmount) {
     $lineItems = CRM_Price_BAO_LineItem::getLineItemsByContributionID($trxnParams['contribution_id']);

diff --git a/CRM/Contribute/Form/AbstractEditPayment.php b/CRM/Contribute/Form/AbstractEditPayment.php
index 62f1fe7a0b301cd38b3c3dfc891da40982ff8e48..196a0c348baae2090d1b8333bed4c92ad51787a9 100644 (file)
--- a/CRM/Contribute/Form/AbstractEditPayment.php
+++ b/CRM/Contribute/Form/AbstractEditPayment.php
@@ -58,7 +58,9 @@ class CRM_Contribute_Form_AbstractEditPayment extends CRM_Contact_Form_Task {
   public $_fields = [];
 
   /**
-   * @var array current payment processor including a copy of the object in 'object' key
+   * Current payment processor including a copy of the object in 'object' key.
+   *
+   * @var array
    */
   public $_paymentProcessor;
 

diff --git a/CRM/Contribute/Form/Contribution.php b/CRM/Contribute/Form/Contribution.php
index 081c9a031512d2a6a6420c5368f80ad00deefc52..0121cd1dbb9db75124df4539b2fec61df6cda8df 100644 (file)
--- a/CRM/Contribute/Form/Contribution.php
+++ b/CRM/Contribute/Form/Contribution.php
@@ -152,7 +152,9 @@ class CRM_Contribute_Form_Contribution extends CRM_Contribute_Form_AbstractEditP
   public $_lineItem;
 
   /**
-   * @var array soft credit info
+   * Soft credit info.
+   *
+   * @var array
    */
   public $_softCreditInfo;
 

diff --git a/CRM/Contribute/Form/ContributionRecur.php b/CRM/Contribute/Form/ContributionRecur.php
index 602cbe9d2fee8e8ce5c83421e59fc4dba8074750..20aa64f1725f31f199ec74d1de6e668e420a5c0f 100644 (file)
--- a/CRM/Contribute/Form/ContributionRecur.php
+++ b/CRM/Contribute/Form/ContributionRecur.php
@@ -39,12 +39,16 @@ class CRM_Contribute_Form_ContributionRecur extends CRM_Core_Form {
   use CRM_Core_Form_EntityFormTrait;
 
   /**
-   * @var int Contribution ID
+   * Contribution ID.
+   *
+   * @var int
    */
   protected $_coid = NULL;
 
   /**
-   * @var int Contribution Recur ID
+   * Contribution Recur ID.
+   *
+   * @var int
    */
   protected $_crid = NULL;
 
@@ -59,7 +63,9 @@ class CRM_Contribute_Form_ContributionRecur extends CRM_Core_Form {
   protected $contributionRecurID = NULL;
 
   /**
-   * @var int Membership ID
+   * Membership ID.
+   *
+   * @var int
    */
   protected $_mid = NULL;
 
@@ -71,10 +77,11 @@ class CRM_Contribute_Form_ContributionRecur extends CRM_Core_Form {
   protected $_paymentProcessorObj = NULL;
 
   /**
-   * @var array
+   * Current payment processor.
    *
-   * Current payment processor including a copy of the object in 'object' key for
-   * legacy reasons.
+   * This includes a copy of the object in 'object' key for legacy reasons.
+   *
+   * @var array
    */
   public $_paymentProcessor = [];
 

diff --git a/CRM/Contribute/Page/UserDashboard.php b/CRM/Contribute/Page/UserDashboard.php
index 32c231782f0c88e0e8008e51369d1c3b70be69c9..289051836a9da2c400e79f99765f4822e6241094 100644 (file)
--- a/CRM/Contribute/Page/UserDashboard.php
+++ b/CRM/Contribute/Page/UserDashboard.php
@@ -74,7 +74,7 @@ class CRM_Contribute_Page_UserDashboard extends CRM_Contact_Page_View_UserDashBo
             'ccid' => $row['contribution_id'],
             'cs' => $this->getUserChecksum(),
             'cid' => $row['contact_id'],
-          ])
+          ]),
         ];
       }
     }