From 5ba7d840bec22dc06e083210cc42cb29adcb56f7 Mon Sep 17 00:00:00 2001
From: eileen <emcnaughton@wikimedia.org>
Date: Sun, 26 May 2019 11:32:10 +1200
Subject: [PATCH] [NFC] phpdoc cleanup

Fixes style elements that stricter phpcs picks up
---
 CRM/Contribute/BAO/Contribution.php         | 14 +++++++-------
 CRM/Contribute/Form/AbstractEditPayment.php |  4 +++-
 CRM/Contribute/Form/Contribution.php        |  4 +++-
 CRM/Contribute/Form/ContributionRecur.php   | 19 +++++++++++++------
 CRM/Contribute/Page/UserDashboard.php       |  2 +-
 5 files changed, 27 insertions(+), 16 deletions(-)

diff --git a/CRM/Contribute/BAO/Contribution.php b/CRM/Contribute/BAO/Contribution.php
index bc6840e43b..6141caf4ab 100644
--- 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 62f1fe7a0b..196a0c348b 100644
--- 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 081c9a0315..0121cd1dbb 100644
--- 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 602cbe9d2f..20aa64f172 100644
--- 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 32c231782f..289051836a 100644
--- 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'],
-          ])
+          ]),
         ];
       }
     }
-- 
2.25.1