INFRA-132 add full stops

[civicrm-core.git] / CRM / Core / QuickForm / Action / Display.php

diff --git a/CRM/Core/QuickForm/Action/Display.php b/CRM/Core/QuickForm/Action/Display.php
index d785e34c6319270e30a31259e86748606e9fc504..2bb6da1149d5ff215fe68f30189d914281c764ab 100644 (file)
--- a/CRM/Core/QuickForm/Action/Display.php
+++ b/CRM/Core/QuickForm/Action/Display.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        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  * Redefine the display action.
@@ -36,39 +36,40 @@
 class CRM_Core_QuickForm_Action_Display extends CRM_Core_QuickForm_Action {
 
   /**
-   * the template to display the required "red" asterick
+   * The template to display the required "red" asterick
    * @var string
    */
   static $_requiredTemplate = NULL;
 
   /**
-   * the template to display error messages inline with the form element
+   * The template to display error messages inline with the form element.
    * @var string
    */
   static $_errorTemplate = NULL;
 
   /**
-   * class constructor
+   * Class constructor.
    *
-   * @param object $stateMachine reference to state machine object
+   * @param object $stateMachine
+   *   Reference to state machine object.
    *
    * @return \CRM_Core_QuickForm_Action_Display
-  @access public
    */
-  function __construct(&$stateMachine) {
+  public function __construct(&$stateMachine) {
     parent::__construct($stateMachine);
   }
 
   /**
    * Processes the request.
    *
-   * @param  object    $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
+   *   CRM_Core_Form the current form-page.
+   * @param string $actionName
+   *   Current action name, as one Action object can serve multiple actions.
    *
    * @return void
-   * @access public
    */
-  function perform(&$page, $actionName) {
+  public function perform(&$page, $actionName) {
     $pageName = $page->getAttribute('id');
 
     // If the original action was 'display' and we have values in container then we load them
@@ -101,17 +102,15 @@ class CRM_Core_QuickForm_Action_Display extends CRM_Core_QuickForm_Action {
   }
 
   /**
-   * render the page using a custom templating
-   * system
+   * Render the page using a custom templating system.
    *
-   * @param object $page the CRM_Core_Form page
+   * @param CRM_Core_Form $page
+   *   The CRM_Core_Form page.
    *
-   * @internal param bool $ret should we echo or return output
    *
    * @return void
-   * @access public
    */
-  function renderForm(&$page) {
+  public function renderForm(&$page) {
     $this->_setRenderTemplates($page);
     $template = CRM_Core_Smarty::singleton();
     $form = $page->toSmarty();
@@ -188,14 +187,14 @@ class CRM_Core_QuickForm_Action_Display extends CRM_Core_QuickForm_Action {
   }
 
   /**
-   * set the various rendering templates
+   * Set the various rendering templates.
    *
-   * @param object  $page the CRM_Core_Form page
+   * @param CRM_Core_Form $page
+   *   The CRM_Core_Form page.
    *
    * @return void
-   * @access public
    */
-  function _setRenderTemplates(&$page) {
+  public function _setRenderTemplates(&$page) {
     if (self::$_requiredTemplate === NULL) {
       $this->initializeTemplates();
     }
@@ -207,14 +206,11 @@ class CRM_Core_QuickForm_Action_Display extends CRM_Core_QuickForm_Action {
   }
 
   /**
-   * initialize the various templates
-   *
-   * @internal param object $page the CRM_Core_Form page
+   * Initialize the various templates.
    *
    * @return void
-   * @access public
    */
-  function initializeTemplates() {
+  public function initializeTemplates() {
     if (self::$_requiredTemplate !== NULL) {
       return;
     }
@@ -229,5 +225,5 @@ class CRM_Core_QuickForm_Action_Display extends CRM_Core_QuickForm_Action {
     self::$_requiredTemplate = file_get_contents($templateDir . '/CRM/Form/label.tpl');
     self::$_errorTemplate = file_get_contents($templateDir . '/CRM/Form/error.tpl');
   }
-}
 
+}