X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=api%2FException.php;h=bba5e6e4f71937006b192ae4beab032c7e1326dd;hb=6217835b7e794c886c50f33638f6c8b845554166;hp=1ee7914cbf64cd30549598b861568ef28210ac02;hpb=6f2500ee7589360102875df4367568fe87485df6;p=civicrm-core.git

diff --git a/api/Exception.php b/api/Exception.php
index 1ee7914cbf..bba5e6e4f7 100644
--- a/api/Exception.php
+++ b/api/Exception.php
@@ -1,11 +1,11 @@
 <?php
 /**
+ * @file
  * File for the CiviCRM APIv3 API wrapper
  *
  * @package CiviCRM_APIv3
- * @subpackage API
  *
- * @copyright CiviCRM LLC (c) 2004-2014
+ * @copyright CiviCRM LLC (c) 2004-2016
  */
 
 /**
@@ -23,6 +23,8 @@ class API_Exception extends Exception {
   private $extraParams = array();
 
   /**
+   * Class constructor.
+   *
    * @param string $message
    *   The human friendly error message.
    * @param mixed $error_code
@@ -47,8 +49,9 @@ 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() {
@@ -56,6 +59,8 @@ class API_Exception extends Exception {
   }
 
   /**
+   * Get extra parameters.
+   *
    * @return array
    */
   public function getExtraParams() {
@@ -63,6 +68,8 @@ class API_Exception extends Exception {
   }
 
   /**
+   * Get error codes.
+   *
    * @return array
    */
   public function getErrorCodes() {
@@ -74,6 +81,7 @@ class API_Exception extends Exception {
       self::NOT_IMPLEMENTED => 'Entity or method is not implemented',
     );
   }
+
 }
 
 /**
@@ -84,6 +92,8 @@ class CiviCRM_API3_Exception extends Exception {
   private $extraParams = array();
 
   /**
+   * Class constructor.
+   *
    * @param string $message
    *   The human friendly error message.
    * @param mixed $error_code
@@ -101,8 +111,9 @@ 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() {
@@ -110,6 +121,8 @@ class CiviCRM_API3_Exception extends Exception {
   }
 
   /**
+   * Get error code.
+   *
    * @return mixed
    */
   public function getErrorCode() {
@@ -117,9 +130,12 @@ class CiviCRM_API3_Exception extends Exception {
   }
 
   /**
+   * Get extra parameters.
+   *
    * @return array
    */
   public function getExtraParams() {
     return $this->extraParams;
   }
+
 }