add missing phpdoc to HintException

Signed-off-by: Arthur Schiwon <blizzz@arthur-schiwon.de>

diff --git a/lib/private/HintException.php b/lib/private/HintException.php
index 7ff8240afd258a293d28ca9bd45dfc9644cce4ae..1233fdca148c510c2e8aff2a3041a85aa732b0cb 100644 (file)
--- a/lib/private/HintException.php
+++ b/lib/private/HintException.php
@@ -26,19 +26,51 @@
 
 namespace OC;
 
+/**
+ * Class HintException
+ *
+ * An Exception class with the intention to be presented to the end user
+ *
+ * @package OC
+ */
 class HintException extends \Exception {
 
        private $hint;
 
+       /**
+        * HintException constructor.
+        *
+        * @param string $message  The error message. It will be not revealed to the
+        *                         the user (unless the hint is empty) and thus
+        *                         should be not translated.
+        * @param string $hint     A useful message that is presented to the end
+        *                         user. It should be translated, but must not
+        *                         contain sensitive data.
+        * @param int $code
+        * @param \Exception|null $previous
+        */
        public function __construct($message, $hint = '', $code = 0, \Exception $previous = null) {
                $this->hint = $hint;
                parent::__construct($message, $code, $previous);
        }
 
+       /**
+        * Returns a string representation of this Exception that includes the error
+        * code, the message and the hint.
+        *
+        * @return string
+        */
        public function __toString() {
                return __CLASS__ . ": [{$this->code}]: {$this->message} ({$this->hint})\n";
        }
 
+       /**
+        * Returns the hint with the intention to be presented to the end user. If
+        * an empty hint was specified upon instatiation, the message is returned
+        * instead.
+        *
+        * @return string
+        */
        public function getHint() {
                if (empty($this->hint)) {
                        return $this->message;