Remove useless param and return annotations

Author: alcaeus

phpcs.xml.dist

@@ -112,7 +112,6 @@
         </properties>
 
         <exclude name="SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingTraversableTypeHintSpecification" />
-        <exclude name="SlevomatCodingStandard.TypeHints.ParameterTypeHint.UselessAnnotation" />
     </rule>
 
     <rule ref="SlevomatCodingStandard.TypeHints.PropertyTypeHint">
@@ -126,7 +125,6 @@
         </properties>
 
         <exclude name="SlevomatCodingStandard.TypeHints.PropertyTypeHint.MissingTraversableTypeHintSpecification" />
-        <exclude name="SlevomatCodingStandard.TypeHints.PropertyTypeHint.UselessAnnotation" />
     </rule>
 
     <rule ref="SlevomatCodingStandard.TypeHints.ReturnTypeHint">
@@ -140,7 +138,6 @@
         </properties>
 
         <exclude name="SlevomatCodingStandard.TypeHints.ReturnTypeHint.MissingTraversableTypeHintSpecification" />
-        <exclude name="SlevomatCodingStandard.TypeHints.ReturnTypeHint.UselessAnnotation" />
     </rule>
 
 

src/BulkWriteResult.php

@@ -35,8 +35,7 @@ class BulkWriteResult
     private $isAcknowledged;
 
     /**
-     * @param WriteResult $writeResult
-     * @param mixed[]     $insertedIds
+     * @param mixed[] $insertedIds
      */
     public function __construct(WriteResult $writeResult, array $insertedIds)
     {

src/ChangeStream.php

@@ -90,8 +90,6 @@ class ChangeStream implements Iterator
 
     /**
      * @internal
-     * @param ChangeStreamIterator $iterator
-     * @param callable             $resumeCallable
      */
     public function __construct(ChangeStreamIterator $iterator, callable $resumeCallable)
     {
@@ -194,8 +192,6 @@ public function valid()
      * Determines if an exception is a resumable error.
      *
      * @see https://github.com/mongodb/specifications/blob/master/source/change-streams/change-streams.rst#resumable-error
-     * @param RuntimeException $exception
-     * @return boolean
      */
     private function isResumableError(RuntimeException $exception): bool
     {
@@ -251,8 +247,6 @@ private function onIteration(bool $incrementKey): void
 
     /**
      * Recreates the ChangeStreamIterator after a resumable server error.
-     *
-     * @return void
      */
     private function resume(): void
     {
@@ -265,7 +259,6 @@ private function resume(): void
     /**
      * Either resumes after a resumable error or re-throws the exception.
      *
-     * @param RuntimeException $exception
      * @throws RuntimeException
      */
     private function resumeOrThrow(RuntimeException $exception): void

src/Command/ListCollections.php

@@ -103,7 +103,6 @@ public function __construct(string $databaseName, array $options = [])
      * Execute the operation.
      *
      * @see Executable::execute()
-     * @param Server $server
      * @return CachingIterator
      * @throws DriverRuntimeException for other driver errors (e.g. connection errors)
      */
@@ -117,8 +116,6 @@ public function execute(Server $server)
 
     /**
      * Create the listCollections command.
-     *
-     * @return Command
      */
     private function createCommand(): Command
     {

src/Command/ListDatabases.php

@@ -99,7 +99,6 @@ public function __construct(array $options = [])
      * Execute the operation.
      *
      * @see Executable::execute()
-     * @param Server $server
      * @return array An array of database info structures
      * @throws UnexpectedValueException if the command response was malformed
      * @throws DriverRuntimeException for other driver errors (e.g. connection errors)
@@ -119,8 +118,6 @@ public function execute(Server $server)
 
     /**
      * Create the listDatabases command.
-     *
-     * @return Command
      */
     private function createCommand(): Command
     {

src/Database.php

@@ -257,8 +257,7 @@ public function command($command, array $options = [])
      * Create a new collection explicitly.
      *
      * @see CreateCollection::__construct() for supported options
-     * @param string $collectionName
-     * @param array  $options
+     * @param array $options
      * @return array|object Command result document
      * @throws UnsupportedException if options are not supported by the selected server
      * @throws InvalidArgumentException for parameter/option parsing errors

src/GridFS/Bucket.php

@@ -641,7 +641,6 @@ public function uploadFromStream(string $filename, $source, array $options = [])
      * Creates a path for an existing GridFS file.
      *
      * @param stdClass $file GridFS file document
-     * @return string
      */
     private function createPathForFile(stdClass $file): string
     {
@@ -662,8 +661,6 @@ private function createPathForFile(stdClass $file): string
 
     /**
      * Creates a path for a new GridFS file, which does not yet have an ID.
-     *
-     * @return string
      */
     private function createPathForUpload(): string
     {
@@ -677,8 +674,6 @@ private function createPathForUpload(): string
 
     /**
      * Returns the names of the files collection.
-     *
-     * @return string
      */
     private function getFilesNamespace(): string
     {
@@ -692,7 +687,6 @@ private function getFilesNamespace(): string
      * respect the Bucket's type map.
      *
      * @param resource $stream GridFS stream
-     * @return stdClass
      * @throws InvalidArgumentException
      */
     private function getRawFileDocumentForStream($stream): stdClass

src/GridFS/CollectionWrapper.php

@@ -138,8 +138,6 @@ public function findChunksByFileId($id, int $fromChunk = 0)
      *
      * @see Bucket::downloadToStreamByName()
      * @see Bucket::openDownloadStreamByName()
-     * @param string  $filename
-     * @param integer $revision
      * @return stdClass|null
      */
     public function findFileByFilenameAndRevision(string $filename, int $revision)
@@ -277,8 +275,7 @@ public function insertFile($file)
     /**
      * Updates the filename field in the file document for a given ID.
      *
-     * @param mixed  $id
-     * @param string $filename
+     * @param mixed $id
      * @return UpdateResult
      */
     public function updateFilenameForId($id, string $filename)
@@ -375,8 +372,6 @@ private function indexKeysMatch(array $expectedKeys, array $actualKeys): bool
 
     /**
      * Returns whether the files collection is empty.
-     *
-     * @return boolean
      */
     private function isFilesCollectionEmpty(): bool
     {

src/GridFS/ReadableStream.php

@@ -196,7 +196,6 @@ public function readBytes(int $length)
     /**
      * Seeks the chunk and buffer offsets for the next read operation.
      *
-     * @param integer $offset
      * @throws InvalidArgumentException if $offset is out of range
      */
     public function seek(int $offset)

src/GridFS/StreamWrapper.php

@@ -281,7 +281,6 @@ private function getStatTemplate(): array
      * Initialize the protocol from the given path.
      *
      * @see StreamWrapper::stream_open()
-     * @param string $path
      */
     private function initProtocol(string $path): void
     {
@@ -293,7 +292,6 @@ private function initProtocol(string $path): void
      * Initialize the internal stream for reading.
      *
      * @see StreamWrapper::stream_open()
-     * @return boolean
      */
     private function initReadableStream(): bool
     {
@@ -311,7 +309,6 @@ private function initReadableStream(): bool
      * Initialize the internal stream for writing.
      *
      * @see StreamWrapper::stream_open()
-     * @return boolean
      */
     private function initWritableStream(): bool
     {