From 4bf0b605aee4f59a5f7dbfb42f316ae8f0d1fec7 Mon Sep 17 00:00:00 2001
From: Andreas Hennings <andreas@dqxtech.net>
Date: Tue, 11 Feb 2014 19:19:57 +0100
Subject: [PATCH] More docblock stuff.

---
 CRM/Contribute/Page/ContributionPage.php | 13 +++++++++----
 CRM/Core/Config/Variables.php            |  5 +++++
 CRM/Core/Controller.php                  | 23 +++++++++++++++--------
 CRM/Core/Page.php                        |  3 ++-
 CRM/Core/QuickForm/Action/Done.php       |  6 ++++--
 5 files changed, 35 insertions(+), 15 deletions(-)

diff --git a/CRM/Contribute/Page/ContributionPage.php b/CRM/Contribute/Page/ContributionPage.php
index 67b6c8639b..1ceebe9b71 100644
--- a/CRM/Contribute/Page/ContributionPage.php
+++ b/CRM/Contribute/Page/ContributionPage.php
@@ -58,8 +58,14 @@ class CRM_Contribute_Page_ContributionPage extends CRM_Core_Page {
 
   private static $_links = NULL;
 
+  /**
+   * @var CRM_Utils_Pager
+   */
   protected $_pager = NULL;
 
+  /**
+   * @var string
+   */
   protected $_sortByCharacter;
 
   /**
@@ -268,7 +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
@@ -380,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) {
diff --git a/CRM/Core/Config/Variables.php b/CRM/Core/Config/Variables.php
index c6da07606d..443c332078 100644
--- a/CRM/Core/Config/Variables.php
+++ b/CRM/Core/Config/Variables.php
@@ -253,7 +253,12 @@ class CRM_Core_Config_Variables extends CRM_Core_Config_Defaults {
   public $userFrameworkUsersTableName = 'users';
   public $userFrameworkClass = 'CRM_Utils_System_Drupal';
   public $userHookClass = 'CRM_Utils_Hook_Drupal';
+
+  /**
+   * @var string|CRM_Core_Permission_Base
+   */
   public $userPermissionClass = 'CRM_Core_Permission_Drupal';
+
   public $userFrameworkURLVar = 'q';
   public $userFrameworkDSN = NULL;
   public $userFrameworkBaseURL = NULL;
diff --git a/CRM/Core/Controller.php b/CRM/Core/Controller.php
index a384ff8bb2..dfa475c648 100644
--- a/CRM/Core/Controller.php
+++ b/CRM/Core/Controller.php
@@ -117,6 +117,8 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller {
 
   /**
    * QF response type
+   *
+   * @var string
    */
   public $_QFResponseType = 'html';
 
@@ -159,15 +161,19 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller {
   /**
    * All CRM single or multi page pages should inherit from this class.
    *
-   * @param string $title descriptive title of the controller
-   * @param bool $modal whether controller is modal
-   * @param null $mode
-   * @param string $scope name of session if we want unique scope, used only by Controller_Simple
-   * @param bool $addSequence should we add a unique sequence number to the end of the key
-   * @param bool $ignoreKey should we not set a qfKey for this controller (for standalone forms)
-   *
+   * @param string $title
+   *   Descriptive title of the controller.
+   * @param bool $modal
+   *   Whether controller is modal.
+   * @param mixed $mode
+   * @param string $scope
+   *   Name of session if we want unique scope, used only by Controller_Simple.
+   * @param bool $addSequence
+   *   Should we add a unique sequence number to the end of the key.
+   * @param bool $ignoreKey 
+   *   Should we not set a qfKey for this controller (for standalone forms).
    *
-   * @return CRM_Core_Controller
+   * @internal param bool $whether controller is modal
    */
   function __construct(
     $title = NULL,
@@ -327,6 +333,7 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller {
    * This run is basically a composition of the original run and the
    * jump action
    *
+   * @return mixed
    */
   public function run() {
     // the names of the action and page should be saved
diff --git a/CRM/Core/Page.php b/CRM/Core/Page.php
index d90f98066e..f77dfa0b12 100644
--- a/CRM/Core/Page.php
+++ b/CRM/Core/Page.php
@@ -165,7 +165,8 @@ class CRM_Core_Page {
    * pages. This typically involves assigning the appropriate
    * smarty variable :)
    *
-   * @return string The content generated by running this page
+   * @return string
+   *   The content generated by running this page
    */
   public function run() {
     if ($this->_embedded) {
diff --git a/CRM/Core/QuickForm/Action/Done.php b/CRM/Core/QuickForm/Action/Done.php
index 90e2d45181..f07ea2d649 100644
--- a/CRM/Core/QuickForm/Action/Done.php
+++ b/CRM/Core/QuickForm/Action/Done.php
@@ -53,8 +53,10 @@ class CRM_Core_QuickForm_Action_Done extends CRM_Core_QuickForm_Action {
    * and if success, call post process
    * when done processing pop to user context
    *
-   * @param  CRM_Core_Form    $page       CRM_Core_Form the current form-page
-   * @param  string    $actionName Current action name, as one Action object can serve multiple actions
+   * @param CRM_Core_Form $page
+   *   The current form-page.
+   * @param string $actionName
+   *   Current action name, as one Action object can serve multiple actions.
    *
    * @return void
    */
-- 
2.25.1