INFRA-132 - @param type fixes

[civicrm-core.git] / CRM / Grant / Info.php

diff --git a/CRM/Grant/Info.php b/CRM/Grant/Info.php
index 45cdd8ab2d08d608b0a356f5fb11507013c7579f..127456278d13fc3ab93378ea36fc26d2ae0c684a 100644 (file)
--- a/CRM/Grant/Info.php
+++ b/CRM/Grant/Info.php
@@ -1,9 +1,9 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.4                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013                                |
+ | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -31,7 +31,7 @@
  * abstract class.
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
  * $Id$
  *
  */
@@ -41,6 +41,9 @@ class CRM_Grant_Info extends CRM_Core_Component_Info {
   protected $keyword = 'grant';
 
   // docs inherited from interface
+  /**
+   * @return array
+   */
   public function getInfo() {
     return array(
       'name' => 'CiviGrant',
@@ -54,6 +57,11 @@ class CRM_Grant_Info extends CRM_Core_Component_Info {
 
 
   // docs inherited from interface
+  /**
+   * @param bool $getAllUnconditionally
+   *
+   * @return array
+   */
   public function getPermissions($getAllUnconditionally = FALSE) {
     return array(
       'access CiviGrant',
@@ -63,44 +71,65 @@ class CRM_Grant_Info extends CRM_Core_Component_Info {
   }
 
   // docs inherited from interface
+  /**
+   * @return null
+   */
   public function getUserDashboardElement() {
     // no dashboard element for this component
     return NULL;
   }
 
   // docs inherited from interface
+  /**
+   * @return null
+   */
   public function getUserDashboardObject() {
     // no dashboard element for this component
     return NULL;
   }
 
   // docs inherited from interface
+  /**
+   * @return array
+   */
   public function registerTab() {
-    return array('title' => ts('Grants'),
+    return array(
+    'title' => ts('Grants'),
       'url' => 'grant',
       'weight' => 50,
     );
   }
 
   // docs inherited from interface
+  /**
+   * @return array
+   */
   public function registerAdvancedSearchPane() {
-    return array('title' => ts('Grants'),
+    return array(
+    'title' => ts('Grants'),
       'weight' => 50,
     );
   }
 
   // docs inherited from interface
+  /**
+   * @return null
+   */
   public function getActivityTypes() {
     return NULL;
   }
 
   // add shortcut to Create New
+  /**
+   * @param $shortCuts
+   */
   public function creatNewShortcut(&$shortCuts) {
     if (CRM_Core_Permission::check('access CiviGrant') &&
       CRM_Core_Permission::check('edit grants')
     ) {
       $shortCuts = array_merge($shortCuts, array(
-        array('path' => 'civicrm/grant/add',
+        array(
+      'path' => 'civicrm/grant/add',
             'query' => "reset=1&action=add&context=standalone",
             'ref' => 'new-grant',
             'title' => ts('Grant'),
@@ -108,4 +137,3 @@ class CRM_Grant_Info extends CRM_Core_Component_Info {
     }
   }
 }
-