comment fixes

[civicrm-core.git] / CRM / Utils / API / AbstractFieldCoder.php

diff --git a/CRM/Utils/API/AbstractFieldCoder.php b/CRM/Utils/API/AbstractFieldCoder.php
index 8e658652e1b49a6f9951ff70b3d3721cc3567d89..2101844d1dcc214f0d5275facb0ed947bc4379d8 100644 (file)
--- a/CRM/Utils/API/AbstractFieldCoder.php
+++ b/CRM/Utils/API/AbstractFieldCoder.php
@@ -1,9 +1,9 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.6                                                |
+ | CiviCRM version 4.7                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -23,16 +23,14 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  * Base class for writing API_Wrappers which generically manipulate the content
  * of all fields (except for some black-listed skip-fields).
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2014
- * $Id$
- *
+ * @copyright CiviCRM LLC (c) 2004-2015
  */
 
 require_once 'api/Wrapper.php';
@@ -51,7 +49,8 @@ abstract class CRM_Utils_API_AbstractFieldCoder implements API_Wrapper {
 
   /**
    * @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 function isSkippedField($fldName) {
     $skipFields = $this->getSkipFields();
@@ -93,7 +92,7 @@ abstract class CRM_Utils_API_AbstractFieldCoder implements API_Wrapper {
   public abstract function decodeOutput(&$values);
 
   /**
-   * {@inheritDoc}
+   * @inheritDoc
    */
   public function fromApiInput($apiRequest) {
     $lowerAction = strtolower($apiRequest['action']);
@@ -118,7 +117,7 @@ abstract class CRM_Utils_API_AbstractFieldCoder implements API_Wrapper {
   }
 
   /**
-   * {@inheritDoc}
+   * @inheritDoc
    */
   public function toApiOutput($apiRequest, $result) {
     $lowerAction = strtolower($apiRequest['action']);
@@ -143,4 +142,5 @@ abstract class CRM_Utils_API_AbstractFieldCoder implements API_Wrapper {
   protected function isApiControlField($key) {
     return (FALSE !== strpos($key, '.'));
   }
+
 }