X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;ds=sidebyside;f=CRM%2FContribute%2FInfo.php;h=bfd3b3638daa51188c431d280c4bc47fc742e83c;hb=c9109f52be8f3869ecbb691b07a8b60d82a68594;hp=8c95978dc9f43cd0dc27eebaf438e5dbae71f0a5;hpb=8f6ae60501d5d64ddbc6269648e71247dee0ce1b;p=civicrm-core.git

diff --git a/CRM/Contribute/Info.php b/CRM/Contribute/Info.php
index 8c95978dc9..bfd3b3638d 100644
--- a/CRM/Contribute/Info.php
+++ b/CRM/Contribute/Info.php
@@ -1,7 +1,7 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -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,18 +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
-   * @access public
-   *
+   * @return array
+   *   collection of required component settings
    */
   /**
    * @return array
@@ -64,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.
@@ -75,8 +76,8 @@ class CRM_Contribute_Info extends CRM_Core_Component_Info {
    *
    * @param bool $getAllUnconditionally
    *
-   * @return array|null collection of permissions, null if none
-   * @access public
+   * @return array|null
+   *   collection of permissions, null if none
    */
   /**
    * @param bool $getAllUnconditionally
@@ -93,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
    */
   /**
@@ -107,56 +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
-   * @access public
-   *
    */
   /**
    * @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
-   * @access public
-   *
    */
   /**
    * @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
-   * @access public
-   *
    */
   /**
    * @return array|null
@@ -168,16 +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
-   * @access public
-   *
+   * @return array|null
+   *   collection of activity types
    */
   /**
    * @return array|null
@@ -186,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
    */
@@ -213,5 +213,5 @@ class CRM_Contribute_Info extends CRM_Core_Component_Info {
       $shortCuts = array_merge($shortCuts, $shortCut);
     }
   }
-}
 
+}