Civi\Angular - Docblock improvements.

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

diff --git a/CRM/Utils/API/AbstractFieldCoder.php b/CRM/Utils/API/AbstractFieldCoder.php
index 681693ac7b2b1dd711cb0bbc66f9eb61ddb5bfc3..d4efe23d1664e5267ba64d26275a1f707b39aeb7 100644 (file)
--- a/CRM/Utils/API/AbstractFieldCoder.php
+++ b/CRM/Utils/API/AbstractFieldCoder.php
@@ -23,7 +23,7 @@
  | 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
@@ -51,7 +51,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();
@@ -78,7 +79,7 @@ abstract class CRM_Utils_API_AbstractFieldCoder implements API_Wrapper {
   }
 
   /**
-   * This function is going to filter the
+   * going to filter the
    * submitted values.
    *
    * @param array|string $values the field value from the API
@@ -93,7 +94,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 +119,7 @@ abstract class CRM_Utils_API_AbstractFieldCoder implements API_Wrapper {
   }
 
   /**
-   * {@inheritDoc}
+   * @inheritDoc
    */
   public function toApiOutput($apiRequest, $result) {
     $lowerAction = strtolower($apiRequest['action']);
@@ -143,4 +144,5 @@ abstract class CRM_Utils_API_AbstractFieldCoder implements API_Wrapper {
   protected function isApiControlField($key) {
     return (FALSE !== strpos($key, '.'));
   }
+
 }