Documentation

src/Header/Part/AddressGroupPart.php

@@ -12,8 +12,8 @@
  * Holds a group of addresses, and an optional group name.
  * 
  * Because AddressGroupConsumer is only called once a colon (":") character is
- * found, an AddressGroupPart is initially constructed without a $name.  Once it is
- * returned to AddressConsumer, a new AddressGroupPart is created out of
+ * found, an AddressGroupPart is initially constructed without a $name.  Once it
+ * is returned to AddressConsumer, a new AddressGroupPart is created out of
  * AddressGroupConsumer's AddressGroupPart.
  *
  * @author Zaahid Bateson
@@ -42,7 +42,7 @@ public function __construct(MbWrapper $charsetConverter, array $addresses, $name
     /**
      * Return the AddressGroupPart's array of addresses.
      * 
-     * @return AddressPart[]
+     * @return AddressPart[] An array of address parts.
      */
     public function getAddresses()
     {
@@ -52,8 +52,8 @@ public function getAddresses()
     /**
      * Returns the AddressPart at the passed index or null.
      * 
-     * @param int $index
-     * @return Address
+     * @param int $index The 0-based index.
+     * @return AddressPart|null The address.
      */
     public function getAddress($index)
     {
@@ -66,7 +66,7 @@ public function getAddress($index)
     /**
      * Returns the name of the group
      * 
-     * @return string
+     * @return string The name
      */
     public function getName()
     {

src/Header/Part/AddressPart.php

@@ -46,7 +46,7 @@ public function __construct(MbWrapper $charsetConverter, $name, $email)
     /**
      * Returns the email address.
      * 
-     * @return string
+     * @return string The email address.
      */
     public function getEmail()
     {

src/Header/Part/CommentPart.php

@@ -5,6 +5,7 @@
  * @license http://opensource.org/licenses/bsd-license.php BSD
  */
 namespace ZBateson\MailMimeParser\Header\Part;
+
 use ZBateson\MbWrapper\MbWrapper;
 
 /**

src/Header/Part/DatePart.php

@@ -25,7 +25,7 @@ class DatePart extends LiteralPart
     /**
      * Tries parsing the passed token as an RFC 2822 date, and failing that into
      * an RFC 822 date, and failing that, tries to parse it by calling
-     * ``` new DateTime($value) ```.
+     * new DateTime($value).
      *
      * @param MbWrapper $charsetConverter
      * @param string $token

src/Header/Part/ParameterPart.php

@@ -53,7 +53,7 @@ public function __construct(MbWrapper $charsetConverter, $name, $value, $languag
     /**
      * Returns the name of the parameter.
      * 
-     * @return string
+     * @return string The name.
      */
     public function getName()
     {
@@ -64,7 +64,7 @@ public function getName()
      * Returns the RFC-1766 (or subset) language tag, if the parameter is a
      * split RFC-2231 part with a language tag set.
      * 
-     * @return string
+     * @return string the language
      */
     public function getLanguage()
     {

src/Header/Part/ReceivedDomainPart.php

@@ -63,11 +63,13 @@ public function __construct(MbWrapper $charsetConverter, $name, $value, $ehloNam
 
     /**
      * Returns the name used to identify the server in the first part of the
-     * extended-domain line.  Note that this is not necessarily the name used in
-     * the EHLO line to an SMTP server, since implementations differ so much,
-     * not much can be guaranteed except the position it was parsed in.
+     * extended-domain line.
      *
-     * @return string
+     * Note that this is not necessarily the name used in the EHLO line to an
+     * SMTP server, since implementations differ so much, not much can be
+     * guaranteed except the position it was parsed in.
+     *
+     * @return string|null The name
      */
     public function getEhloName()
     {
@@ -78,7 +80,7 @@ public function getEhloName()
      * Returns the hostname of the server, or whatever string in the hostname
      * position when parsing (but never an address).
      *
-     * @return string
+     * @return string|null
      */
     public function getHostname()
     {
@@ -89,7 +91,7 @@ public function getHostname()
      * Returns the address of the server, or whatever string that looks like an
      * address in the address position when parsing (but never a hostname).
      *
-     * @return string
+     * @return string|null
      */
     public function getAddress()
     {

src/Header/Part/Token.php

@@ -14,7 +14,7 @@
  * 
  * A Token is meant to hold a value for further processing -- for instance when
  * consuming an address list header (like From or To) -- before it's known what
- * type of HeaderPart it is (could be an email address, could be a name, or
+ * type of IHeaderPart it is (could be an email address, could be a name, or
  * could be a group.)
  *
  * @author Zaahid Bateson