Missing doc comments added

Author: Webklex

src/IMAP/Attachment.php

@@ -81,6 +81,8 @@ class Attachment {
      * @param Message   $oMessage
      * @param object    $structure
      * @param integer   $part_number
+     *
+     * @throws Exceptions\ConnectionFailedException
      */
     public function __construct(Message $oMessage, $structure, $part_number = 1) {
         $this->oMessage = $oMessage;
@@ -128,6 +130,8 @@ protected function findType() {
 
     /**
      * Fetch the given attachment
+     *
+     * @throws Exceptions\ConnectionFailedException
      */
     protected function fetch() {
 

src/IMAP/ClientManager.php

@@ -16,6 +16,8 @@
  * Class ClientManager
  *
  * @package Webklex\IMAP
+ *
+ * @mixin Client
  */
 class ClientManager {
 

src/IMAP/Query/Query.php

@@ -218,6 +218,7 @@ public function generate_query() {
 
     /**
      * @return Client
+     * @throws \Webklex\IMAP\Exceptions\ConnectionFailedException
      */
     public function getClient() {
         $this->client->checkConnection();

src/IMAP/Query/WhereQuery.php

@@ -14,9 +14,10 @@
 
 use Webklex\IMAP\Exceptions\InvalidWhereQueryCriteriaException;
 use Webklex\IMAP\Exceptions\MethodNotFoundException;
+use Webklex\IMAP\Exceptions\MessageSearchValidationException;
 
 /**
- * Class Query
+ * Class WhereQuery
  *
  * @package Webklex\IMAP\Query
  * 
@@ -44,6 +45,8 @@
  * @method WhereQuery body($value)
  * @method WhereQuery before($date)
  * @method WhereQuery bcc($value)
+ *
+ * @mixin Query
  */
 class WhereQuery extends Query {
 
@@ -92,10 +95,11 @@ protected function validate_criteria($criteria) {
     }
 
     /**
-     * @param string|array $criteria
-     * @param mixed $value
-     *
+     * @param mixed $criteria
+     * @param null  $value
+     * 
      * @return $this
+     * @throws InvalidWhereQueryCriteriaException
      */
     public function where($criteria, $value = null) {
         if(is_array($criteria)){
@@ -146,32 +150,35 @@ public function andWhere(\Closure $closure = null) {
 
     /**
      * @return WhereQuery
+     * @throws InvalidWhereQueryCriteriaException
      */
     public function whereAll() {
         return $this->where('ALL');
     }
 
     /**
      * @return WhereQuery
+     * @throws InvalidWhereQueryCriteriaException
      */
     public function whereAnswered() {
         return $this->where('ANSWERED');
     }
 
     /**
      * @param string $value
-     *
+     * 
      * @return WhereQuery
+     * @throws InvalidWhereQueryCriteriaException
      */
     public function whereBcc($value) {
         return $this->where('BCC', $value);
     }
 
     /**
      * @param mixed $value
-     *
      * @return WhereQuery
-     * @throws \Webklex\IMAP\Exceptions\MessageSearchValidationException
+     * @throws InvalidWhereQueryCriteriaException
+     * @throws MessageSearchValidationException
      */
     public function whereBefore($value) {
         $date = $this->parse_date($value);
@@ -182,6 +189,7 @@ public function whereBefore($value) {
      * @param string $value
      *
      * @return WhereQuery
+     * @throws InvalidWhereQueryCriteriaException
      */
     public function whereBody($value) {
         return $this->where('BODY', $value);
@@ -191,13 +199,15 @@ public function whereBody($value) {
      * @param string $value
      *
      * @return WhereQuery
+     * @throws InvalidWhereQueryCriteriaException
      */
     public function whereCc($value) {
         return $this->where('CC', $value);
     }
 
     /**
      * @return WhereQuery
+     * @throws InvalidWhereQueryCriteriaException
      */
     public function whereDeleted() {
         return $this->where('DELETED');
@@ -207,6 +217,7 @@ public function whereDeleted() {
      * @param string $value
      *
      * @return WhereQuery
+     * @throws InvalidWhereQueryCriteriaException
      */
     public function whereFlagged($value) {
         return $this->where('FLAGGED', $value);
@@ -216,6 +227,7 @@ public function whereFlagged($value) {
      * @param string $value
      *
      * @return WhereQuery
+     * @throws InvalidWhereQueryCriteriaException
      */
     public function whereFrom($value) {
         return $this->where('FROM', $value);
@@ -225,20 +237,23 @@ public function whereFrom($value) {
      * @param string $value
      *
      * @return WhereQuery
+     * @throws InvalidWhereQueryCriteriaException
      */
     public function whereKeyword($value) {
         return $this->where('KEYWORD', $value);
     }
 
     /**
      * @return WhereQuery
+     * @throws InvalidWhereQueryCriteriaException
      */
     public function whereNew() {
         return $this->where('NEW');
     }
 
     /**
      * @return WhereQuery
+     * @throws InvalidWhereQueryCriteriaException
      */
     public function whereOld() {
         return $this->where('OLD');
@@ -248,7 +263,8 @@ public function whereOld() {
      * @param mixed $value
      *
      * @return WhereQuery
-     * @throws \Webklex\IMAP\Exceptions\MessageSearchValidationException
+     * @throws MessageSearchValidationException
+     * @throws InvalidWhereQueryCriteriaException
      */
     public function whereOn($value) {
         $date = $this->parse_date($value);
@@ -257,13 +273,15 @@ public function whereOn($value) {
 
     /**
      * @return WhereQuery
+     * @throws InvalidWhereQueryCriteriaException
      */
     public function whereRecent() {
         return $this->where('RECENT');
     }
 
     /**
      * @return WhereQuery
+     * @throws InvalidWhereQueryCriteriaException
      */
     public function whereSeen() {
         return $this->where('SEEN');
@@ -273,7 +291,8 @@ public function whereSeen() {
      * @param mixed $value
      *
      * @return WhereQuery
-     * @throws \Webklex\IMAP\Exceptions\MessageSearchValidationException
+     * @throws MessageSearchValidationException
+     * @throws InvalidWhereQueryCriteriaException
      */
     public function whereSince($value) {
         $date = $this->parse_date($value);
@@ -284,6 +303,7 @@ public function whereSince($value) {
      * @param string $value
      *
      * @return WhereQuery
+     * @throws InvalidWhereQueryCriteriaException
      */
     public function whereSubject($value) {
         return $this->where('SUBJECT', $value);
@@ -293,6 +313,7 @@ public function whereSubject($value) {
      * @param string $value
      *
      * @return WhereQuery
+     * @throws InvalidWhereQueryCriteriaException
      */
     public function whereText($value) {
         return $this->where('TEXT', $value);
@@ -302,6 +323,7 @@ public function whereText($value) {
      * @param string $value
      *
      * @return WhereQuery
+     * @throws InvalidWhereQueryCriteriaException
      */
     public function whereTo($value) {
         return $this->where('TO', $value);
@@ -311,34 +333,39 @@ public function whereTo($value) {
      * @param string $value
      *
      * @return WhereQuery
+     * @throws InvalidWhereQueryCriteriaException
      */
     public function whereUnkeyword($value) {
         return $this->where('UNKEYWORD', $value);
     }
 
     /**
      * @return WhereQuery
+     * @throws InvalidWhereQueryCriteriaException
      */
     public function whereUnanswered() {
         return $this->where('UNANSWERED');
     }
 
     /**
      * @return WhereQuery
+     * @throws InvalidWhereQueryCriteriaException
      */
     public function whereUndeleted() {
         return $this->where('UNDELETED');
     }
 
     /**
      * @return WhereQuery
+     * @throws InvalidWhereQueryCriteriaException
      */
     public function whereUnflagged() {
         return $this->where('UNFLAGGED');
     }
 
     /**
      * @return WhereQuery
+     * @throws InvalidWhereQueryCriteriaException
      */
     public function whereUnseen() {
         return $this->where('UNSEEN');