From 8deefe64a216f4d0c0d0965c6ce3a3227343f16c Mon Sep 17 00:00:00 2001
From: Eileen McNaughton <eileen@fuzion.co.nz>
Date: Fri, 9 May 2014 14:08:37 +1200
Subject: [PATCH] bulk comment fixes

---
 tests/phpunit/CiviTest/CiviUnitTestCase.php   | 17 ++++++++++++++--
 tools/CRM/Auction/BAO/Auction.php             |  1 +
 tools/CRM/Auction/BAO/Item.php                |  1 +
 .../org.civicrm.multisite/multisite.php       | 20 ++++++++++---------
 4 files changed, 28 insertions(+), 11 deletions(-)

diff --git a/tests/phpunit/CiviTest/CiviUnitTestCase.php b/tests/phpunit/CiviTest/CiviUnitTestCase.php
index 1dbec53565..36324c20d5 100644
--- a/tests/phpunit/CiviTest/CiviUnitTestCase.php
+++ b/tests/phpunit/CiviTest/CiviUnitTestCase.php
@@ -801,6 +801,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase {
   /**
    * This function exists to wrap api getsingle function & check the result
    * so we can ensure they succeed & throw exceptions without litterering the test with checks
+   *
    * @param string $entity
    * @param array $params
    * @param array $checkAgainst - array to compare result against
@@ -810,6 +811,8 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase {
    * - string
    * - array
    * - object
+   *
+   * @return array|int
    */
   function callAPISuccessGetSingle($entity, $params, $checkAgainst = NULL) {
     $params += array(
@@ -1362,6 +1365,8 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase {
    * Function to delete contribution
    *
    * @param int $contributionId
+   *
+   * @return array|int
    */
   function contributionDelete($contributionId) {
     $params = array(
@@ -1413,7 +1418,9 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase {
   /**
    * Function to delete event
    *
-   * @param int $id  ID of the event
+   * @param int $id ID of the event
+   *
+   * @return array|int
    */
   function eventDelete($id) {
     $params = array(
@@ -1426,6 +1433,8 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase {
    * Function to delete participant
    *
    * @param int $participantID
+   *
+   * @return array|int
    */
   function participantDelete($participantID) {
     $params = array(
@@ -1837,7 +1846,9 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase {
   /**
    * Function to delete custom group
    *
-   * @param int    $customGroupID
+   * @param int $customGroupID
+   *
+   * @return array|int
    */
   function customGroupDelete($customGroupID) {
     $params['id'] = $customGroupID;
@@ -1876,6 +1887,8 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase {
    * Function to delete custom field
    *
    * @param int $customFieldID
+   *
+   * @return array|int
    */
   function customFieldDelete($customFieldID) {
 
diff --git a/tools/CRM/Auction/BAO/Auction.php b/tools/CRM/Auction/BAO/Auction.php
index bf4e027176..1477ba3170 100644
--- a/tools/CRM/Auction/BAO/Auction.php
+++ b/tools/CRM/Auction/BAO/Auction.php
@@ -124,6 +124,7 @@ class CRM_Auction_BAO_Auction extends CRM_Auction_DAO_Auction {
    *
    * @param array $params reference array contains the values submitted by the form
    *
+   * @return object
    * @access public
    * @static
    *
diff --git a/tools/CRM/Auction/BAO/Item.php b/tools/CRM/Auction/BAO/Item.php
index c02b403d5e..0e9f14460e 100644
--- a/tools/CRM/Auction/BAO/Item.php
+++ b/tools/CRM/Auction/BAO/Item.php
@@ -136,6 +136,7 @@ class CRM_Auction_BAO_Item extends CRM_Auction_DAO_Auction {
    *
    * @param array $params reference array contains the values submitted by the form
    *
+   * @return object
    * @access public
    * @static
    *
diff --git a/tools/extensions/org.civicrm.multisite/multisite.php b/tools/extensions/org.civicrm.multisite/multisite.php
index 11df5c4f86..1e2a7aa7a0 100644
--- a/tools/extensions/org.civicrm.multisite/multisite.php
+++ b/tools/extensions/org.civicrm.multisite/multisite.php
@@ -268,15 +268,17 @@ function _multisite_get_domain_group($permission = 1) {
     return $groupID;
   }
 
-  /**
-   * Should we be adding ACLs in this instance. If we don't add them the user
-   * will not be able to see anything. We check if the install has the permissions
-   * hook implemented correctly & if so only allow view & edit based on those.
-   *
-   * Otherwise all users get these permissions added (4.2 vs 4.3 / other CMS issues)
-   *
-   * @param integer $type type of operation
-   */
+/**
+ * Should we be adding ACLs in this instance. If we don't add them the user
+ * will not be able to see anything. We check if the install has the permissions
+ * hook implemented correctly & if so only allow view & edit based on those.
+ *
+ * Otherwise all users get these permissions added (4.2 vs 4.3 / other CMS issues)
+ *
+ * @param integer $type type of operation
+ *
+ * @return bool
+ */
   function _multisite_add_permissions($type){
     $hookclass = 'CRM_Utils_Hook';
     if(!method_exists($hookclass, 'permissions')){
-- 
2.25.1