Merge pull request #5314 from mlutfy/4.6-crm16059

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

diff --git a/CRM/Contribute/Info.php b/CRM/Contribute/Info.php
index 88e57343aa2bb30176608d7fd8db3679c40fd36c..bfd3b3638daa51188c431d280c4bc47fc742e83c 100644 (file)
--- a/CRM/Contribute/Info.php
+++ b/CRM/Contribute/Info.php
@@ -23,7 +23,7 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  * This class introduces component to the system and provides all the
@@ -38,17 +38,19 @@
 class CRM_Contribute_Info extends CRM_Core_Component_Info {
 
 
-  // docs inherited from interface
+  /**
+   * @inheritDoc
+   */
   protected $keyword = 'contribute';
 
-  // docs inherited from interface
   /**
+   * @inheritDoc
    * Provides base information about the component.
    * Needs to be implemented in component's information
    * class.
    *
-   * @return array collection of required component settings
-   *
+   * @return array
+   *   collection of required component settings
    */
   /**
    * @return array
@@ -63,8 +65,8 @@ class CRM_Contribute_Info extends CRM_Core_Component_Info {
     );
   }
 
-  // docs inherited from interface
   /**
+   * @inheritDoc
    * Provides permissions that are used by component.
    * Needs to be implemented in component's information
    * class.
@@ -74,7 +76,8 @@ class CRM_Contribute_Info extends CRM_Core_Component_Info {
    *
    * @param bool $getAllUnconditionally
    *
-   * @return array|null collection of permissions, null if none
+   * @return array|null
+   *   collection of permissions, null if none
    */
   /**
    * @param bool $getAllUnconditionally
@@ -91,9 +94,10 @@ class CRM_Contribute_Info extends CRM_Core_Component_Info {
   }
 
   /**
-   * Provides permissions that are unwise for Anonymous Roles to have
+   * Provides permissions that are unwise for Anonymous Roles to have.
    *
-   * @return array list of permissions
+   * @return array
+   *   list of permissions
    * @see CRM_Component_Info::getPermissions
    */
   /**
@@ -105,53 +109,55 @@ class CRM_Contribute_Info extends CRM_Core_Component_Info {
     );
   }
 
-  // docs inherited from interface
   /**
+   * @inheritDoc
    * Provides information about user dashboard element
    * offered by this component.
    *
-   * @return array|null collection of required dashboard settings,
+   * @return array|null
+   *   collection of required dashboard settings,
    *                    null if no element offered
-   *
    */
   /**
    * @return array|null
    */
   public function getUserDashboardElement() {
-    return array('name' => ts('Contributions'),
+    return array(
+      'name' => ts('Contributions'),
       'title' => ts('Your Contribution(s)'),
       'perm' => array('make online contributions'),
       'weight' => 10,
     );
   }
 
-  // docs inherited from interface
   /**
+   * @inheritDoc
    * Provides information about user dashboard element
    * offered by this component.
    *
-   * @return array|null collection of required dashboard settings,
+   * @return array|null
+   *   collection of required dashboard settings,
    *                    null if no element offered
-   *
    */
   /**
    * @return array|null
    */
   public function registerTab() {
-    return array('title' => ts('Contributions'),
+    return array(
+      'title' => ts('Contributions'),
       'url' => 'contribution',
       'weight' => 20,
     );
   }
 
-  // docs inherited from interface
   /**
+   * @inheritDoc
    * Provides information about advanced search pane
    * offered by this component.
    *
-   * @return array|null collection of required pane settings,
+   * @return array|null
+   *   collection of required pane settings,
    *                    null if no element offered
-   *
    */
   /**
    * @return array|null
@@ -163,15 +169,15 @@ class CRM_Contribute_Info extends CRM_Core_Component_Info {
     );
   }
 
-  // docs inherited from interface
   /**
+   * @inheritDoc
    * Provides potential activity types that this
    * component might want to register in activity history.
    * Needs to be implemented in component's information
    * class.
    *
-   * @return array|null collection of activity types
-   *
+   * @return array|null
+   *   collection of activity types
    */
   /**
    * @return array|null
@@ -180,8 +186,8 @@ class CRM_Contribute_Info extends CRM_Core_Component_Info {
     return NULL;
   }
 
-  // add shortcut to Create New
   /**
+   * add shortcut to Create New.
    * @param $shortCuts
    * @param $newCredit
    */
@@ -207,4 +213,5 @@ class CRM_Contribute_Info extends CRM_Core_Component_Info {
       $shortCuts = array_merge($shortCuts, $shortCut);
     }
   }
+
 }