Merge pull request #5386 from colemanw/CRM-15706
[civicrm-core.git] / CRM / Core / Exception.php
index 4d12f3aba9204c5676522aff9232a35fed5951ba..2722c6b73bb5cd5cafa20ca3ba591d63fe323333 100644 (file)
@@ -1,5 +1,4 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
@@ -24,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 exceptions generated by CiviCRM.
@@ -34,7 +33,7 @@
  *   The human friendly error message.
  * @param string $error_code
  *   A computer friendly error code. By convention, no space (but underscore allowed).
- *  ex: mandatory_missing, duplicate, invalid_format
+ *   ex: mandatory_missing, duplicate, invalid_format
  * @param array $data
  *   Extra params to return. eg an extra array of ids. It is not mandatory, but can help the computer using the api. Keep in mind the api consumer isn't to be trusted. eg. the database password is NOT a good extra data.
  */
@@ -52,8 +51,8 @@ class CRM_Core_Exception extends PEAR_Exception {
     $this->errorData = $errorData + array('error_code' => $error_code);
   }
 
-  // custom string representation of object
   /**
+   * custom string representation of object.
    * @return string
    */
   public function __toString() {
@@ -81,4 +80,5 @@ class CRM_Core_Exception extends PEAR_Exception {
   public function getErrorData() {
     return $this->errorData;
   }
+
 }