More docblock stuff.
[civicrm-core.git] / CRM / Contribute / Page / ContributionPage.php
index e71d40e5d5059489101b42e1baa66879735ff524..1ceebe9b71f920b4303c2f18cb9c1d4050181255 100644 (file)
@@ -58,16 +58,22 @@ class CRM_Contribute_Page_ContributionPage extends CRM_Core_Page {
 
   private static $_links = NULL;
 
+  /**
+   * @var CRM_Utils_Pager
+   */
   protected $_pager = NULL;
 
+  /**
+   * @var string
+   */
   protected $_sortByCharacter;
 
   /**
    * Get the action links for this page.
    *
-   * @return array $_actionLinks
-   *
-   */ function &actionLinks() {
+   * @return array
+   */
+  function &actionLinks() {
     // check if variable _actionsLinks is populated
     if (!isset(self::$_actionLinks)) {
       // helper variable for nicer formatting
@@ -107,8 +113,7 @@ class CRM_Contribute_Page_ContributionPage extends CRM_Core_Page {
   /**
    * Get the configure action links for this page.
    *
-   * @return array $_configureActionLinks
-   *
+   * @return array
    */
   public function &configureActionLinks() {
     // check if variable _actionsLinks is populated
@@ -189,8 +194,7 @@ class CRM_Contribute_Page_ContributionPage extends CRM_Core_Page {
   /**
    * Get the online contribution links.
    *
-   * @return array $_onlineContributionLinks.
-   *
+   * @return array
    */
   public function &onlineContributionLinks() {
     if (!isset(self::$_onlineContributionLinks)) {
@@ -221,8 +225,7 @@ class CRM_Contribute_Page_ContributionPage extends CRM_Core_Page {
   /**
    * Get the contributions links.
    *
-   * @return array $_contributionLinks
-   *
+   * @return array
    */
   public function &contributionLinks() {
     if (!isset(self::$_contributionLinks)) {
@@ -271,8 +274,7 @@ class CRM_Contribute_Page_ContributionPage extends CRM_Core_Page {
    * type of action and executes that action.
    * Finally it calls the parent's run method.
    *
-   * @return void
-   *
+   * @return mixed
    */
   public function run() {
     // get the requested action
@@ -384,9 +386,8 @@ AND         cp.page_type = 'contribute'
   /**
    * Browse all contribution pages
    *
-   * @param null $action
-   *
-   * @return void
+   * @param mixed $action
+   *   Unused parameter.
    * @static
    */
   public function browse($action = NULL) {