comment fixes
authorEileen McNaughton <eileen@fuzion.co.nz>
Sat, 24 May 2014 04:47:46 +0000 (16:47 +1200)
committerEileen McNaughton <eileen@fuzion.co.nz>
Sat, 24 May 2014 05:49:03 +0000 (17:49 +1200)
CRM/Case/BAO/Case.php
CRM/Core/BAO/Setting.php
CRM/Member/BAO/Membership.php
CRM/Utils/Hook.php
api/v3/utils.php

index 17a48a41795a516069f360560c77874f2fb48ae9..74233ba5ed664e6377c0cd144466234427d293fd 100644 (file)
@@ -327,7 +327,7 @@ WHERE civicrm_case.id = %1";
    *
    * @param bool $moveToTrash
    *
-   * @return void
+   * @return bool is successful
    * @access public
    * @static
    */
@@ -2321,7 +2321,7 @@ INNER JOIN  civicrm_case_contact ON ( civicrm_case.id = civicrm_case_contact.cas
    *
    * @param bool $changeClient
    *
-   * @return void.
+   * @return integer|NULL
    * @static
    */
   static function mergeCases($mainContactId, $mainCaseId = NULL, $otherContactId = NULL,
index efa9aa45643ad001d7925debc8271331dc644d43..e81110dc10a5a9fef9f79fc5054b329a40d5a2c2 100644 (file)
@@ -443,7 +443,7 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting {
    *
    * @throws api_Exception
    * @domains array an array of domains to get settings for. Default is the current domain
-   * @return void
+   * @return array
    * @static
    * @access public
    */
index de4711a1ec494b9f3bf0ccfd61fa6f12e273c405..30818483115d4c8489983cda1aeef4df1cbdadd8 100644 (file)
@@ -232,7 +232,7 @@ class CRM_Member_BAO_Membership extends CRM_Member_DAO_Membership {
    * @throws CRM_Core_Exception
    * @internal param bool $callFromAPI Is this function called from API?
    *
-   * @return object CRM_Member_BAO_Membership object
+   * @return CRM_Member_BAO_Membership object
    * @access public
    * @static
    */
index 6405dbcf085b55f7f9af56007eee881d0e85d632..523b4020b43bc2ba6c205580c5e62759ef49de51 100644 (file)
@@ -1607,11 +1607,11 @@ abstract class CRM_Utils_Hook {
   /**
    * This hook is called before a case merge (or a case reassign)
    *
-   * @param type $mainContactId
-   * @param type $mainCaseId
-   * @param type $otherContactId
-   * @param type $otherCaseId
-   * @param bool|\type $changeClient
+   * @param integer $mainContactId
+   * @param integer $mainCaseId
+   * @param integer $otherContactId
+   * @param integer $otherCaseId
+   * @param bool $changeClient
    *
    * @return void
    */
@@ -1622,11 +1622,11 @@ abstract class CRM_Utils_Hook {
   /**
    * This hook is called after a case merge (or a case reassign)
    *
-   * @param type $mainContactId
-   * @param type $mainCaseId
-   * @param type $otherContactId
-   * @param type $otherCaseId
-   * @param bool|\type $changeClient
+   * @param integer $mainContactId
+   * @param integer $mainCaseId
+   * @param integer $otherContactId
+   * @param integer $otherCaseId
+   * @param bool $changeClient
    *
    * @return void
    */
index aa81220ba0353d8a37dea1c6ed1f336f62d854d9..29ebc64b5deff8ba1fcbdfc33404839039114ea8 100644 (file)
@@ -1119,6 +1119,12 @@ function _civicrm_api3_basic_create_fallback($bao_name, &$params) {
 /**
  * Function to do a 'standard' api del - when the api is only doing a $bao::del then use this
  * if api::del doesn't exist it will try DAO delete method
+ *
+ * @param $bao_name
+ * @param $params
+ *
+ * @return array API result array
+ * @throws API_Exception
  */
 function _civicrm_api3_basic_delete($bao_name, &$params) {