Cleanup phpdoc comments

[civicrm-core.git] / CRM / Utils / Hook.php

diff --git a/CRM/Utils/Hook.php b/CRM/Utils/Hook.php
index f9001145391eeca14ebd07a2e09461de6569e5a6..fa8b6be2d3114f3ac0df47b2f6884a0d4496cbaa 100644 (file)
--- a/CRM/Utils/Hook.php
+++ b/CRM/Utils/Hook.php
@@ -109,7 +109,7 @@ abstract class CRM_Utils_Hook {
   );
 
   /**
-   * @param $numParams
+   * @param array $numParams
    * @param $arg1
    * @param $arg2
    * @param $arg3
@@ -161,7 +161,7 @@ abstract class CRM_Utils_Hook {
   /**
    * @param $civiModules
    * @param $fnSuffix
-   * @param $numParams
+   * @param array $numParams
    * @param $arg1
    * @param $arg2
    * @param $arg3
@@ -306,7 +306,7 @@ abstract class CRM_Utils_Hook {
    * This hook is invoked during the CiviCRM form preProcess phase.
    *
    * @param string $formName the name of the form
-   * @param object $form     reference to the form object
+   * @param CRM_Core_Form $form     reference to the form object
    *
    * @return null the return value is ignored
    */
@@ -319,7 +319,7 @@ abstract class CRM_Utils_Hook {
    * be used to set the default values of a form element
    *
    * @param string $formName the name of the form
-   * @param object $form     reference to the form object
+   * @param CRM_Core_Form $form     reference to the form object
    *
    * @return null the return value is ignored
    */
@@ -332,7 +332,7 @@ abstract class CRM_Utils_Hook {
    * any form elements, this hook should save the values in the database
    *
    * @param string $formName the name of the form
-   * @param object $form     reference to the form object
+   * @param CRM_Core_Form $form     reference to the form object
    *
    * @return null the return value is ignored
    */
@@ -512,7 +512,7 @@ abstract class CRM_Utils_Hook {
    * This hook is called when building the amount structure for a Contribution or Event Page
    *
    * @param int    $pageType - is this a contribution or event page
-   * @param object $form     - reference to the form object
+   * @param CRM_Core_Form $form     - reference to the form object
    * @param array  $amount   - the amount structure to be displayed
    *
    * @return null
@@ -921,7 +921,7 @@ abstract class CRM_Utils_Hook {
 
   /**
    * @param $recordBAO
-   * @param $recordID
+   * @param int $recordID
    * @param $isActive
    *
    * @return mixed
@@ -1077,10 +1077,9 @@ abstract class CRM_Utils_Hook {
    * @param string $entity the API entity (like contact)
    * @param string $action the API action (like get)
    * @param array &$params the API parameters
-   * @param $permissions
+   * @param array &$permissions the associative permissions array (probably to be altered by this hook)
    *
    * @return mixed
-   * @internal param array $permisisons the associative permissions array (probably to be altered by this hook)
    */
   static function alterAPIPermissions($entity, $action, &$params, &$permissions) {
     return self::singleton()->invoke(4, $entity, $action, $params, $permissions,
@@ -1090,7 +1089,7 @@ abstract class CRM_Utils_Hook {
   }
 
   /**
-   * @param $dao
+   * @param CRM_Core_DAO $dao
    *
    * @return mixed
    */