locomotivemtl / charcoal-email

src/Charcoal/Email/Email.php

Doc Comments +2 added lines, -2 removed lines

@@ -750,7 +750,7 @@ 
     /**
      * Send the email to all recipients
      *
-     * @return boolean Success / Failure.
+     * @return boolean|null Success / Failure.
      * @todo Implement methods and property for toggling rich-text vs. plain-text
      *       emails (`$mail->isHTML(true)`).
      */
@@ -887,7 +887,7 @@ 
      * Log the send event for each recipient.
      *
      * @param  boolean $result Success or failure.
-     * @param  mixed   $mailer The raw mailer.
+     * @param  PHPMailer   $mailer The raw mailer.
      * @return void
      */
     protected function logSend($result, $mailer)

src/Charcoal/Email/EmailQueueItem.php

Doc Comments +3 added lines, -3 removed lines

@@ -126,7 +126,7 @@ 
     /**
      * Set the recipient's email address.
      *
-     * @param  string|array $email An email address.
+     * @param  string $email An email address.
      * @throws InvalidArgumentException If the email address is invalid.
      * @return EmailQueueItem Chainable
      */
@@ -160,7 +160,7 @@ 
     /**
      * Set the sender's email address.
      *
-     * @param  string|array $email An email address.
+     * @param  string $email An email address.
      * @throws InvalidArgumentException If the email address is invalid.
      * @return EmailQueueItem Chainable
      */
@@ -319,7 +319,7 @@ 
      * @param  callable $callback        An optional callback routine executed after the item is processed.
      * @param  callable $successCallback An optional callback routine executed when the item is resolved.
      * @param  callable $failureCallback An optional callback routine executed when the item is rejected.
-     * @return boolean  Success / Failure
+     * @return null|boolean  Success / Failure
      */
     public function process(
         callable $callback = null,

src/Charcoal/Email/Queue/QueueItemTrait.php

Doc Comments +6 added lines, -6 removed lines

@@ -96,7 +96,7 @@ 
      * Set the queue's ID.
      *
      * @param mixed $id The unique queue identifier.
-     * @return QueueItemInterface Chainable
+     * @return QueueItemTrait Chainable
      */
     public function setQueueId($id)
     {
@@ -119,7 +119,7 @@ 
      * Set the item's processed status.
      *
      * @param boolean $processed Whether the item has been processed.
-     * @return QueueItemInterface Chainable
+     * @return QueueItemTrait Chainable
      */
     public function setProcessed($processed)
     {
@@ -142,7 +142,7 @@ 
      *
      * @param  null|string|DateTimeInterface $ts A date/time string or object.
      * @throws InvalidArgumentException If the date/time is invalid.
-     * @return QueueItemInterface Chainable
+     * @return QueueItemTrait Chainable
      */
     public function setQueuedDate($ts)
     {
@@ -187,7 +187,7 @@ 
      *
      * @param  null|string|DateTimeInterface $ts A date/time string or object.
      * @throws InvalidArgumentException If the date/time is invalid.
-     * @return QueueItemInterface Chainable
+     * @return QueueItemTrait Chainable
      */
     public function setProcessingDate($ts)
     {
@@ -232,7 +232,7 @@ 
      *
      * @param  null|string|DateTimeInterface $ts A date/time string or object.
      * @throws InvalidArgumentException If the date/time is invalid.
-     * @return QueueItemInterface Chainable
+     * @return QueueItemTrait Chainable
      */
     public function setProcessedDate($ts)
     {
@@ -277,7 +277,7 @@ 
      *
      * Presets the item as _to-be_ processed and queued now.
      *
-     * @return QueueItemInterface Chainable
+     * @return QueueItemTrait Chainable
      */
     public function preSaveQueueItem()
     {