comment fixes

[civicrm-core.git] / api / Exception.php

diff --git a/api/Exception.php b/api/Exception.php
index 1b5d544f8e15a6c0c2b2020e15e9317368ded74c..8ec7eb3ae6a8212a13e790b1b6fa02d247dae97f 100644 (file)
--- a/api/Exception.php
+++ b/api/Exception.php
@@ -1,5 +1,6 @@
 <?php
 /**
+ * @file
  * File for the CiviCRM APIv3 API wrapper
  *
  * @package CiviCRM_APIv3
@@ -9,8 +10,12 @@
  */
 
 /**
- * This api exception returns more information than the default one. The aim it let the api consumer know better what is exactly the error without having to parse the error message.
- * If you consume an api that doesn't return an error_code or the extra data you need, consider improving the api and contribute
+ * This api exception returns more information than the default one. The aim
+ * it let the api consumer know better what is exactly the error without
+ * having to parse the error message.
+ *
+ * If you consume an api that doesn't return an error_code or the extra data
+ * you need, consider improving the api and contribute.
  */
 class API_Exception extends Exception {
   const UNAUTHORIZED = 'unauthorized';
@@ -19,6 +24,8 @@ class API_Exception extends Exception {
   private $extraParams = array();
 
   /**
+   * Class constructor.
+   *
    * @param string $message
    *   The human friendly error message.
    * @param mixed $error_code
@@ -43,8 +50,8 @@ class API_Exception extends Exception {
     $this->extraParams = $extraParams + array('error_code' => $error_code);
   }
 
-  // custom string representation of object
   /**
+   * custom string representation of object
    * @return string
    */
   public function __toString() {
@@ -70,6 +77,7 @@ class API_Exception extends Exception {
       self::NOT_IMPLEMENTED => 'Entity or method is not implemented',
     );
   }
+
 }
 
 /**
@@ -97,8 +105,8 @@ class CiviCRM_API3_Exception extends Exception {
     $this->extraParams = $extraParams + array('error_code' => $error_code);
   }
 
-  // custom string representation of object
   /**
+   * custom string representation of object
    * @return string
    */
   public function __toString() {
@@ -118,4 +126,5 @@ class CiviCRM_API3_Exception extends Exception {
   public function getExtraParams() {
     return $this->extraParams;
   }
+
 }