From 67f947ac66c929caf0ca45b1069ffacc62a088f0 Mon Sep 17 00:00:00 2001
From: Eileen McNaughton <eileen@fuzion.co.nz>
Date: Wed, 4 Mar 2015 08:44:16 +1100
Subject: [PATCH] a few comment fixes

---
 CRM/Case/Controller/Search.php            | 4 ++++
 CRM/Core/BAO/CustomField.php              | 4 ++++
 CRM/Core/Payment/GoogleIPN.php            | 2 ++
 CRM/Grant/Controller/Search.php           | 4 ++++
 CRM/Import/DataSource/SQL.php             | 2 ++
 CRM/Member/Controller/Search.php          | 4 ++++
 Civi/Core/Resolver.php                    | 6 +++++-
 api/v3/utils.php                          | 2 +-
 tests/phpunit/api/v3/ContributionTest.php | 2 +-
 9 files changed, 27 insertions(+), 3 deletions(-)

diff --git a/CRM/Case/Controller/Search.php b/CRM/Case/Controller/Search.php
index c9dda84e6f..3239a4c199 100644
--- a/CRM/Case/Controller/Search.php
+++ b/CRM/Case/Controller/Search.php
@@ -48,6 +48,10 @@ class CRM_Case_Controller_Search extends CRM_Core_Controller {
 
   /**
    * Class constructor.
+   *
+   * @param string $title
+   * @param bool|int $action
+   * @param bool $modal
    */
   public function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) {
 
diff --git a/CRM/Core/BAO/CustomField.php b/CRM/Core/BAO/CustomField.php
index 17b461639c..b869dc34e7 100644
--- a/CRM/Core/BAO/CustomField.php
+++ b/CRM/Core/BAO/CustomField.php
@@ -2358,6 +2358,10 @@ WHERE      ( f.label = %1 OR f.name = %1 )
 
   /**
    * Given ID of a custom field, return its name as well as the name of the custom group it belongs to.
+   *
+   * @param array $ids
+   *
+   * @return array
    */
   public static function getNameFromID($ids) {
     if (is_array($ids)) {
diff --git a/CRM/Core/Payment/GoogleIPN.php b/CRM/Core/Payment/GoogleIPN.php
index 05805c6791..dffaba07ea 100644
--- a/CRM/Core/Payment/GoogleIPN.php
+++ b/CRM/Core/Payment/GoogleIPN.php
@@ -516,6 +516,8 @@ WHERE  contribution_recur_id = {$ids['contributionRecur']}
   /**
    * This method is handles the response that will be invoked (from extern/googleNotify) every time
    * a notification or request is sent by the Google Server.
+   *
+   * @param string $xml_response
    */
   public static function main($xml_response) {
     require_once 'Google/library/googleresponse.php';
diff --git a/CRM/Grant/Controller/Search.php b/CRM/Grant/Controller/Search.php
index ebb415c375..450975678b 100644
--- a/CRM/Grant/Controller/Search.php
+++ b/CRM/Grant/Controller/Search.php
@@ -48,6 +48,10 @@ class CRM_Grant_Controller_Search extends CRM_Core_Controller {
 
   /**
    * Class constructor.
+   *
+   * @param string $title
+   * @param bool|int $action
+   * @param bool $modal
    */
   public function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) {
 
diff --git a/CRM/Import/DataSource/SQL.php b/CRM/Import/DataSource/SQL.php
index 886b54cb68..17dfaa8aa2 100644
--- a/CRM/Import/DataSource/SQL.php
+++ b/CRM/Import/DataSource/SQL.php
@@ -46,6 +46,8 @@ class CRM_Import_DataSource_SQL extends CRM_Import_DataSource {
 
   /**
    * Set variables up before form is built.
+   *
+   * @param CRM_Core_Form $form
    */
   public function preProcess(&$form) {
   }
diff --git a/CRM/Member/Controller/Search.php b/CRM/Member/Controller/Search.php
index ac64c676e3..bc9c319cbc 100644
--- a/CRM/Member/Controller/Search.php
+++ b/CRM/Member/Controller/Search.php
@@ -48,6 +48,10 @@ class CRM_Member_Controller_Search extends CRM_Core_Controller {
 
   /**
    * Class constructor.
+   *
+   * @param string $title
+   * @param bool|int $action
+   * @param bool $modal
    */
   public function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) {
 
diff --git a/Civi/Core/Resolver.php b/Civi/Core/Resolver.php
index bf3845f8d6..0d332fe36d 100644
--- a/Civi/Core/Resolver.php
+++ b/Civi/Core/Resolver.php
@@ -184,11 +184,15 @@ class ResolverApi {
   }
 
   /**
+   * Create placeholders.
+   *
+   * @param string $prefix
    * @param array $args
    *   Positional arguments.
+   *
    * @return array
    *   Named placeholders based on the positional arguments
-   *   (e.g. "@1" => "firstValue").
+   * (e.g. "@1" => "firstValue").
    */
   protected function createPlaceholders($prefix, $args) {
     $result = array();
diff --git a/api/v3/utils.php b/api/v3/utils.php
index 8c053187a4..802a93174b 100644
--- a/api/v3/utils.php
+++ b/api/v3/utils.php
@@ -1847,7 +1847,7 @@ function _civicrm_api_get_custom_fields($entity, &$params) {
 /**
  * Translate the custom field data_type attribute into a std 'type'.
  *
- * @param $dataType
+ * @param array $value
  *
  * @return int
  */
diff --git a/tests/phpunit/api/v3/ContributionTest.php b/tests/phpunit/api/v3/ContributionTest.php
index a83084d4c3..0295ec5376 100644
--- a/tests/phpunit/api/v3/ContributionTest.php
+++ b/tests/phpunit/api/v3/ContributionTest.php
@@ -1661,7 +1661,7 @@ class api_v3_ContributionTest extends CiviUnitTestCase {
    *
    * @param array $params
    * @param int $id
-   * @param bool int $delete
+   * @param bool $delete
    */
   public function contributionGetnCheck($params, $id, $delete = TRUE) {
 
-- 
2.25.1