Mass cleanup of docblocks/code/comments

[civicrm-core.git] / CRM / Admin / Form / Setting.php

diff --git a/CRM/Admin/Form/Setting.php b/CRM/Admin/Form/Setting.php
index 6220d38133c5a3b021b4fada371531327c1e4b3b..ccbf3d443661cdd76a26288b25b2b10b74244faf 100644 (file)
--- a/CRM/Admin/Form/Setting.php
+++ b/CRM/Admin/Form/Setting.php
@@ -1,9 +1,9 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.4                                                |
+ | CiviCRM version 4.5                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013                                |
+ | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -28,7 +28,7 @@
 /**
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
  * $Id$
  *
  */
@@ -43,7 +43,7 @@ class CRM_Admin_Form_Setting extends CRM_Core_Form {
   protected $_settings = array();
 
   /**
-   * This function sets the default values for the form.
+   * Set default values for the form.
    * default values are retrieved from the database
    *
    * @access public
@@ -114,7 +114,7 @@ class CRM_Admin_Form_Setting extends CRM_Core_Form {
   }
 
   /**
-   * Function to actually build the form
+   * Build the form object
    *
    * @return void
    * @access public
@@ -167,7 +167,7 @@ class CRM_Admin_Form_Setting extends CRM_Core_Form {
   }
 
   /**
-   * Function to process the form
+   * Process the form submission
    *
    * @access public
    *
@@ -180,6 +180,9 @@ class CRM_Admin_Form_Setting extends CRM_Core_Form {
     self::commonProcess($params);
   }
 
+  /**
+   * @param array $params
+   */
   public function commonProcess(&$params) {
 
     // save autocomplete search options
@@ -264,7 +267,7 @@ AND    time_format <> ''
       unset($params[$setting]);
     }
     CRM_Core_BAO_ConfigSetting::create($params);
-    CRM_Core_Session::setStatus(" ", ts('Changes Saved.'), "success");
+    CRM_Core_Session::setStatus(" ", ts('Changes Saved'), "success");
   }
 
   public function rebuildMenu() {