From e51d62d3234600bfb1ad49a24977c33c0131d2d8 Mon Sep 17 00:00:00 2001
From: eileenmcnaughton <eileen@fuzion.co.nz>
Date: Thu, 22 Oct 2015 01:51:56 +0000
Subject: [PATCH] comment fixes

---
 CRM/Core/Form.php | 27 ++++++++++++++++++++-------
 1 file changed, 20 insertions(+), 7 deletions(-)

diff --git a/CRM/Core/Form.php b/CRM/Core/Form.php
index 2f328fcf59..da258205e6 100644
--- a/CRM/Core/Form.php
+++ b/CRM/Core/Form.php
@@ -252,11 +252,15 @@ class CRM_Core_Form extends HTML_QuickForm_Page {
     $this->assign('snippet', CRM_Utils_Array::value('snippet', $_GET));
   }
 
+  /**
+   * Generate ID for some reason & purpose that is unknown & undocumented.
+   */
   public static function generateID() {
   }
 
   /**
-   * Add one or more css classes to the form
+   * Add one or more css classes to the form.
+   *
    * @param string $className
    */
   public function addClass($className) {
@@ -303,8 +307,9 @@ class CRM_Core_Form extends HTML_QuickForm_Page {
   }
 
   /**
-   * Simple easy to use wrapper around addElement. Deal with
-   * simple validation rules
+   * Simple easy to use wrapper around addElement.
+   *
+   * Deal with simple validation rules.
    *
    * @param string $type
    * @param string $name
@@ -314,7 +319,8 @@ class CRM_Core_Form extends HTML_QuickForm_Page {
    * @param array $extra
    *   (attributes for select elements).
    *
-   * @return HTML_QuickForm_Element could be an error object
+   * @return HTML_QuickForm_Element
+   *   Could be an error object
    */
   public function &add(
     $type, $name, $label = '',
@@ -368,6 +374,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page {
    *
    * @param string $name
    * @param string $label
+   *
    * @return HTML_QuickForm_Element
    */
   public function addMonthDay($name, $label) {
@@ -377,8 +384,10 @@ class CRM_Core_Form extends HTML_QuickForm_Page {
   }
 
   /**
-   * called before buildForm. Any pre-processing that
-   * needs to be done for buildForm should be done here
+   * Preprocess form.
+   *
+   * This is called before buildForm. Any pre-processing that
+   * needs to be done for buildForm should be done here.
    *
    * This is a virtual function and should be redefined if needed.
    */
@@ -398,7 +407,10 @@ class CRM_Core_Form extends HTML_QuickForm_Page {
   }
 
   /**
-   * just a wrapper, so that we can call all the hook functions
+   * Main process wrapper.
+   *
+   * Implemented so that we can call all the hook functions.
+   *
    * @param bool $allowAjax
    *   FIXME: This feels kind of hackish, ideally we would take the json-related code from this function.
    *                          and bury it deeper down in the controller
@@ -424,6 +436,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page {
 
   /**
    * The postProcess hook is typically called by the framework.
+   *
    * However in a few cases, the form exits or redirects early in which
    * case it needs to call this function so other modules can do the needful
    * Calling this function directly should be avoided if possible. In general a
-- 
2.25.1