Merge pull request #5078 from eileenmcnaughton/comment-full-stops

[civicrm-core.git] / CRM / Core / HTMLInputCoder.php

diff --git a/CRM/Core/HTMLInputCoder.php b/CRM/Core/HTMLInputCoder.php
index 50cc79783222ee0db15ea736b706b66b2a880b08..470ceb3dd1452edee021f98f4cf5977f12a43466 100644 (file)
--- a/CRM/Core/HTMLInputCoder.php
+++ b/CRM/Core/HTMLInputCoder.php
@@ -1,7 +1,7 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -23,23 +23,29 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
+
+/**
+ * Class CRM_Core_HTMLInputCoder
+ */
 class CRM_Core_HTMLInputCoder {
 
   /**
    * @param string $fldName
-   * @return bool TRUE if encoding should be skipped for this field
+   * @return bool
+   *   TRUE if encoding should be skipped for this field
    */
   public static function isSkippedField($fldName) {
     return CRM_Utils_API_HTMLInputCoder::singleton()->isSkippedField($fldName);
   }
 
   /**
-   * This function is going to filter the
+   * going to filter the
    * submitted values across XSS vulnerability.
    *
    * @param array|string $values
-   * @param bool $castToString If TRUE, all scalars will be filtered (and therefore cast to strings)
+   * @param bool $castToString
+   *   If TRUE, all scalars will be filtered (and therefore cast to strings).
    *    If FALSE, then non-string values will be preserved
    */
   public static function encodeInput(&$values, $castToString = TRUE) {