Civi/API - Code style

[civicrm-core.git] / Civi / API / Exception / UnauthorizedException.php

diff --git a/Civi/API/Exception/UnauthorizedException.php b/Civi/API/Exception/UnauthorizedException.php
index 7162a04f74343858deac44533d93ed346dfb93bb..55ff1dfcaaffde4ffb8d89b55ff30286592b7f12 100644 (file)
--- a/Civi/API/Exception/UnauthorizedException.php
+++ b/Civi/API/Exception/UnauthorizedException.php
@@ -10,10 +10,15 @@ require_once 'api/Exception.php';
 class UnauthorizedException extends \API_Exception {
   /**
    * @param string $message
+   *   The human friendly error message.
    * @param array $extraParams
-   * @param Exception $previous
+   *   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.
+   * @param \Exception|NULL $previous
+   *   A previous exception which caused this new exception.
    */
-  public function __construct($message, $extraParams = array(), Exception $previous = NULL) {
+  public function __construct($message, $extraParams = array(), \Exception $previous = NULL) {
     parent::__construct($message, \API_Exception::UNAUTHORIZED, $extraParams, $previous);
   }
 }