From b8950542840e0d0456d56db34f9a5b981ef5d210 Mon Sep 17 00:00:00 2001
From: Eileen McNaughton <eileen@fuzion.co.nz>
Date: Thu, 8 May 2014 12:39:29 +1200
Subject: [PATCH] comment fixes

---
 CRM/Contribute/BAO/Contribution/Utils.php | 14 ++++++++------
 CRM/Contribute/BAO/ContributionPage.php   |  1 +
 CRM/Utils/Request.php                     |  8 +++-----
 3 files changed, 12 insertions(+), 11 deletions(-)

diff --git a/CRM/Contribute/BAO/Contribution/Utils.php b/CRM/Contribute/BAO/Contribution/Utils.php
index 02df597459..9439d93d9f 100644
--- a/CRM/Contribute/BAO/Contribution/Utils.php
+++ b/CRM/Contribute/BAO/Contribution/Utils.php
@@ -37,14 +37,16 @@ class CRM_Contribute_BAO_Contribution_Utils {
   /**
    * Function to process payment after confirmation
    *
-   * @param object  $form   form object
-   * @param array   $paymentParams   array with payment related key
+   * @param object $form form object
+   * @param array $paymentParams array with payment related key
    * value pairs
-   * @param array   $premiumParams   array with premium related key
+   * @param array $premiumParams array with premium related key
    * value pairs
-   * @param int     $contactID       contact id
-     * @param int     $contributionTypeId   financial type id
-   * @param int     $component   component id
+   * @param int $contactID contact id
+   * @param int $contributionTypeId financial type id
+   * @param int|string $component component id
+   *
+   * @param null $fieldTypes
    *
    * @return array associated array
    *
diff --git a/CRM/Contribute/BAO/ContributionPage.php b/CRM/Contribute/BAO/ContributionPage.php
index faaf7c4b40..a952e1e2b3 100644
--- a/CRM/Contribute/BAO/ContributionPage.php
+++ b/CRM/Contribute/BAO/ContributionPage.php
@@ -271,6 +271,7 @@ class CRM_Contribute_BAO_ContributionPage extends CRM_Contribute_DAO_Contributio
       if ($preID = CRM_Utils_Array::value('custom_pre_id', $values)) {
         if (!empty($values['related_contact'])) {
           $preProfileTypes = CRM_Core_BAO_UFGroup::profileGroups($preID);
+          //@todo - following line should not refer to undefined $postProfileTypes? figure out way to test
           if (in_array('Individual', $preProfileTypes) || in_array('Contact', $postProfileTypes)) {
             //Take Individual contact ID
             $userID = CRM_Utils_Array::value('related_contact', $values);
diff --git a/CRM/Utils/Request.php b/CRM/Utils/Request.php
index 376eeeb9ce..964dbeef4e 100644
--- a/CRM/Utils/Request.php
+++ b/CRM/Utils/Request.php
@@ -60,14 +60,13 @@ class CRM_Utils_Request {
    * @param $name    name of the variable to be retrieved
    * @param $type    type of the variable (see CRM_Utils_Type for details)
    * @param $store   session scope where variable is stored
-   * @param $abort   is this variable required
+   * @param bool|\is $abort is this variable required
    * @param $default default value of the variable if not present
-   * @param $method  where should we look for the variable
+   * @param string|\where $method where should we look for the variable
    *
    * @return mixed the value of the variable
    * @access public
    * @static
-   *
    */
   static function retrieve($name, $type, &$store = NULL, $abort = FALSE, $default = NULL, $method = 'REQUEST') {
 
@@ -126,9 +125,8 @@ class CRM_Utils_Request {
    * This is a replacement for $_REQUEST which includes $_GET/$_POST
    * but excludes $_COOKIE / $_ENV / $_SERVER.
    *
-   * @param string $method
+   * @internal param string $method
    * @return array
-   * @throws CRM_Core_Exception
    */
   static function exportValues() {
     // For more discussion of default $_REQUEST handling, see:
-- 
2.25.1