Implemented a few more PHP CS Fixer changes.

src/Dictionary/Entity.php

@@ -2255,8 +2255,6 @@ class Entity
      * Utility function converts entities into their real unicode characters.
      *
      * @param string $input The input string.
-     *
-     * @return string
      */
     public static function convertEntitiesToUnicode(string $input): string
     {

src/HandlerStack.php

@@ -171,8 +171,6 @@ public function registerNamespaces(Ns $ns): void
 
     /**
      * Returns information about the HandlerStack that is useful for debugging.
-     *
-     * @return array
      */
     public function debugStack(): array
     {
@@ -253,8 +251,6 @@ protected function logRegistration(callable $middleware, ?string $name = null):
      *
      * @param callable    $middleware The middleware to add to the stack.
      * @param string|null $name       A name for the middleware. Can be used with `pushBefore()` and `pushAfter()`.
-     *
-     * @return string
      */
     protected function exceptionMessage(callable $middleware, ?string $name = null): string
     {

src/HandlerStackInterface.php

@@ -36,8 +36,6 @@ interface HandlerStackInterface extends C\SetLoggerInterface
      *                                  will be thrown.
      *
      * @throws MiddlewareException
-     *
-     * @return self
      */
     public function append(callable $middleware, ?string $name = null, ?string $overrideType = null): self;
 
@@ -54,8 +52,6 @@ public function append(callable $middleware, ?string $name = null, ?string $over
      * @param string|null $name         A name for the middleware. Can be used with `pushBefore()` and `pushAfter()`.
      *
      * @throws MiddlewareException
-     *
-     * @return self
      */
     public function appendClosure(string $overrideType, callable $middleware, ?string $name = null): self;
 
@@ -72,8 +68,6 @@ public function appendClosure(string $overrideType, callable $middleware, ?strin
      *                                  will be thrown.
      *
      * @throws MiddlewareException
-     *
-     * @return self
      */
     public function prepend(callable $middleware, ?string $name = null, ?string $overrideType = null): self;
 
@@ -90,8 +84,6 @@ public function prepend(callable $middleware, ?string $name = null, ?string $ove
      * @param string|null $name         A name for the middleware. Can be used with `pushBefore()` and `pushAfter()`.
      *
      * @throws MiddlewareException
-     *
-     * @return self
      */
     public function prependClosure(string $overrideType, callable $middleware, ?string $name = null): self;
 

src/Middleware/AbstractMiddleware.php

@@ -68,8 +68,6 @@ public function addArrayProperty(&$object, string $property): void
      * @param array  $arr     The associative array to check.
      * @param string $key     The key in the associative array to return the value for.
      * @param mixed  $default The default value to return if there is no value. The default value is `null`.
-     *
-     * @return mixed
      */
     public function get(array $arr, string $key, $default = null)
     {

src/Middleware/Xml/AbstractXmlMiddleware.php

@@ -34,8 +34,6 @@ abstract class AbstractXmlMiddleware extends AbstractMiddleware
      * @param bool $makeInsensitive Whether or not the handling should be made case-insensitive. A value of `true`
      *                              means that the handling should be case-insensitive. A value of `false` means that
      *                              the handling should be case-sensitive. The default value is `true`.
-     *
-     * @return self
      */
     public function setCaseInsensitive(bool $makeInsensitive = true): self
     {
@@ -51,8 +49,6 @@ public function setCaseInsensitive(bool $makeInsensitive = true): self
      *
      * @param string $query          An XPath query where `%s` is used in-place of the XML namespace alias.
      * @param string $namespaceAlias The XML namespace alias to apply.
-     *
-     * @return string
      */
     public function applyNsToQuery(string $query, string $namespaceAlias): string
     {

src/Middleware/Xml/XmlInterface.php

@@ -40,8 +40,6 @@ public function __invoke(stdClass $feedRoot, string $namespaceAlias, DOMXPath $x
      *     'http://www.w3.org/2005/Atom' => 'atom10'
      * ];
      * ```
-     *
-     * @return array
      */
     public function getSupportedNamespaces(): array;
 }

src/Mixin/DateTrait.php

@@ -36,8 +36,6 @@ trait DateTrait
      *
      * @param string $createFromFormat The format of the datestamp in the feed.
      *
-     * @return self
-     *
      * @see http://php.net/manual/en/datetime.createfromformat.php
      */
     public function setDateFormat(string $createFromFormat): self
@@ -59,8 +57,6 @@ public function setDateFormat(string $createFromFormat): self
      *
      * @param string $timezone The timezone identifier to use. Must be compatible with `DateTimeZone`. The default
      *                         value is `UTC`.
-     *
-     * @return self
      */
     public function setOutputTimezone(string $timezone = 'UTC'): self
     {

src/Mixin/DeepTypeTrait.php

@@ -35,8 +35,6 @@ trait DeepTypeTrait
      *                                    looking at the response from `getRoot()`.
      * @param string|null $namespaceAlias The XML namespace alias to apply.
      *
-     * @return Node
-     *
      * @phpcs:disable Generic.Functions.OpeningFunctionBraceBsdAllman.BraceOnSameLine
      */
     protected function getScalarSingleValue(
@@ -65,8 +63,6 @@ protected function getScalarSingleValue(
      * @param string      $className      The class name to instantiate when there is not a defined value.
      * @param string|null $namespaceAlias The XML namespace alias to apply.
      *
-     * @return TypeInterface
-     *
      * @phpcs:disable Generic.Functions.OpeningFunctionBraceBsdAllman.BraceOnSameLine
      */
     protected function getComplexSingleValue(
@@ -95,8 +91,6 @@ protected function getComplexSingleValue(
      *                                    looking at the response from `getRoot()`.
      * @param string|null $namespaceAlias The XML namespace alias to apply.
      *
-     * @return iterable
-     *
      * @phpcs:disable Generic.Functions.OpeningFunctionBraceBsdAllman.BraceOnSameLine
      */
     protected function getComplexMultipleValues(

src/Mixin/DomDocumentTrait.php

@@ -26,8 +26,6 @@ trait DomDocumentTrait
 
     /**
      * Gets the DOMDocument object which is being used to parse the content.
-     *
-     * @return DOMDocument
      */
     public function getDomDocument(): DOMDocument
     {

src/Mixin/LoggerTrait.php

@@ -28,7 +28,7 @@ trait LoggerTrait
     /**
      * Sets the PSR-3 logger.
      *
-     * @param LoggerInterface $logger
+     * @param LoggerInterface $logger A PSR-3 compatible logger.
      *
      * @return self
      */
@@ -48,8 +48,6 @@ public function setLogger(LoggerInterface $logger)
 
     /**
      * Retrieves the PSR-3 logger.
-     *
-     * @return LoggerInterface
      */
     public function getLogger(): LoggerInterface
     {

src/Mixin/RawDocumentTrait.php

@@ -24,8 +24,6 @@ trait RawDocumentTrait
 
     /**
      * Retrieves the raw, unparsed contents of the feed's stream.
-     *
-     * @return string
      */
     public function getRawDocument(): string
     {

src/Mixin/RootTrait.php

@@ -24,8 +24,6 @@ trait RootTrait
 
     /**
      * Retrieve the root-most node in the feed.
-     *
-     * @return object
      */
     public function getRoot(): object
     {

src/Parser/AbstractParser.php

@@ -23,8 +23,6 @@ abstract class AbstractParser implements ParserInterface
      *
      * Note: Use of MD5 here is not cryptographically significant.
      *
-     * @return string
-     *
      * @see http://php.net/manual/en/language.oop5.magic.php#object.tostring
      */
     public function __toString(): string

src/Parser/Date.php

@@ -116,8 +116,6 @@ public function __construct(
 
     /**
      * Get the input datestamp.
-     *
-     * @return string
      */
     public function getDatestamp(): string
     {
@@ -126,8 +124,6 @@ public function getDatestamp(): string
 
     /**
      * Get the requested output timezone.
-     *
-     * @return string
      */
     public function getOutputTimezone(): string
     {
@@ -136,8 +132,6 @@ public function getOutputTimezone(): string
 
     /**
      * Get the format used to assist date string parsing.
-     *
-     * @return string|null
      */
     public function getCreateFromFormat(): ?string
     {

src/Parser/Xml.php

@@ -169,8 +169,6 @@ public function __construct(
 
     /**
      * Get the XML namespace handler.
-     *
-     * @return Ns
      */
     public function getNs(): Ns
     {
@@ -179,8 +177,6 @@ public function getNs(): Ns
 
     /**
      * Get the preferred namespace alias.
-     *
-     * @return string|null
      */
     public function getNamespaceAlias(): ?string
     {
@@ -218,8 +214,6 @@ public function xpath()
      * pointer to the next node, then the next until it finds a real XML node.
      *
      * @param DOMNode $node The `DOMNode` element to evaluate.
-     *
-     * @return DOMNode
      */
     public function findNextRealNode(DOMNode $node): DOMNode
     {
@@ -234,8 +228,6 @@ public function findNextRealNode(DOMNode $node): DOMNode
 
     /**
      * Retrieves the object which represents the top-level feed.
-     *
-     * @return Feed
      */
     public function getFeed(): Feed
     {

src/SimplePie.php

@@ -68,7 +68,7 @@ public function __construct()
     /**
      * Sets the libxml value to use for parsing XML.
      *
-     * @param int $libxml
+     * @param int $libxml TODO add a description here.
      *
      * @return int
      */
@@ -90,8 +90,6 @@ public function setLibxml(int $libxml)
 
     /**
      * Gets the libxml value to use for parsing XML.
-     *
-     * @return int
      */
     public function getLibxml(): int
     {
@@ -101,7 +99,7 @@ public function getLibxml(): int
     /**
      * Sets the handler stack which contains registered middleware.
      *
-     * @param HandlerStackInterface $handlerStack
+     * @param HandlerStackInterface $handlerStack TODO add a description here.
      *
      * @return self
      */
@@ -115,8 +113,6 @@ public function setMiddlewareStack(HandlerStackInterface $handlerStack)
 
     /**
      * Gets the handler stack which contains registered middleware.
-     *
-     * @return HandlerStackInterface
      */
     public function getMiddlewareStack(): HandlerStackInterface
     {
@@ -133,19 +129,15 @@ public function getMiddlewareStack(): HandlerStackInterface
      *                                                 should inject the entity definitions. A value of `false` means
      *                                                 that SimplePie should NOT inject the entity definitions. The
      *                                                 default value is `false`.
-     *
-     * @return XmlParser
      */
     public function parseXml(StreamInterface $stream, bool $handleHtmlEntitiesInXml = false): XmlParser
     {
-        $parser = new XmlParser(
+        return new XmlParser(
             $stream,
             $this->logger,
             $this->middleware,
             $this->libxml,
             $handleHtmlEntitiesInXml
         );
-
-        return $parser;
     }
 }

src/Type/AbstractType.php

@@ -22,8 +22,6 @@ abstract class AbstractType
      * @param string $nodeName The name of the method being called.
      * @param array  $args     Any arguments passed into that method.
      *
-     * @return mixed
-     *
      * @internal
      */
     public function __call(string $nodeName, array $args)
@@ -49,8 +47,6 @@ public function __call(string $nodeName, array $args)
      *
      * @param string $nodeName The short version of the call (without the `get`).
      *
-     * @return string
-     *
      * @internal
      */
     protected function getUnresolvableMessage(string $nodeName): string

src/Type/BranchInterface.php

@@ -20,8 +20,6 @@ interface BranchInterface
      *
      * @param string $nodeName The name of the method being called.
      *
-     * @return string
-     *
      * @internal
      */
     public function getAlias(string $nodeName): string;

src/Type/Entry.php

@@ -95,8 +95,6 @@ public function __construct(
 
     /**
      * Converts this object into a string representation.
-     *
-     * @return string
      */
     public function __toString(): string
     {
@@ -105,8 +103,6 @@ public function __toString(): string
 
     /**
      * Gets the DOMNode element.
-     *
-     * @return DOMNode|null
      */
     public function getNode(): ?DOMNode
     {
@@ -117,8 +113,6 @@ public function getNode(): ?DOMNode
      * Finds the common internal alias for a given method name.
      *
      * @param string $nodeName The name of the method being called.
-     *
-     * @return string
      */
     public function getAlias(string $nodeName): string
     {
@@ -160,8 +154,6 @@ public function getAlias(string $nodeName): string
      *
      * @throws SimplePieException
      *
-     * @return mixed
-     *
      * @phpcs:disable Generic.Metrics.CyclomaticComplexity.MaxExceeded
      */
     public function getHandler(string $nodeName, array $args = [])

src/Type/Feed.php

@@ -80,8 +80,6 @@ public function __construct(string $namespaceAlias)
 
     /**
      * Finds the default namespace alias for the feed type.
-     *
-     * @return string
      */
     public function getDefaultNs(): string
     {
@@ -93,8 +91,6 @@ public function getDefaultNs(): string
      *
      * @param string $nodeName The name of the method being called.
      *
-     * @return string
-     *
      * @phpcs:disable Generic.Metrics.CyclomaticComplexity.MaxExceeded
      */
     public function getAlias(string $nodeName): string