Skip to content

Commit

Permalink
style: Remove curly braces around @inheritdoc annotation
Browse files Browse the repository at this point in the history
marcreichel committed Jan 31, 2025
1 parent 16c4cbd commit e703bcd
Showing 8 changed files with 37 additions and 43 deletions.
20 changes: 10 additions & 10 deletions src/Http/Message.php
Original file line number Diff line number Diff line change
@@ -58,7 +58,7 @@ public function getHeaders(): array
}

/**
* {@inheritDoc}
* @inheritDoc
*
* @throws RuntimeException
*/
@@ -73,7 +73,7 @@ public function getBody(): StreamInterface
}

/**
* {@inheritDoc}
* @inheritDoc
*/
#[Override]
public function getProtocolVersion(): string
@@ -82,7 +82,7 @@ public function getProtocolVersion(): string
}

/**
* {@inheritDoc}
* @inheritDoc
*/
#[Override]
public function hasHeader(string $name): bool
@@ -91,7 +91,7 @@ public function hasHeader(string $name): bool
}

/**
* {@inheritDoc}
* @inheritDoc
*/
#[Override]
public function getHeader(string $name): array
@@ -104,7 +104,7 @@ public function getHeader(string $name): array
}

/**
* {@inheritDoc}
* @inheritDoc
*/
#[Override]
public function getHeaderLine(string $name): string
@@ -117,7 +117,7 @@ public function getHeaderLine(string $name): string
}

/**
* {@inheritDoc}
* @inheritDoc
*/
#[Override]
public function withHeader(string $name, $value): self
@@ -135,7 +135,7 @@ public function withHeader(string $name, $value): self
}

/**
* {@inheritDoc}
* @inheritDoc
*/
#[Override]
public function withProtocolVersion(string $version): self
@@ -147,7 +147,7 @@ public function withProtocolVersion(string $version): self
}

/**
* {@inheritDoc}
* @inheritDoc
*/
#[Override]
public function withAddedHeader(string $name, $value): self
@@ -171,7 +171,7 @@ public function withAddedHeader(string $name, $value): self
}

/**
* {@inheritDoc}
* @inheritDoc
*/
#[Override]
public function withoutHeader(string $name): MessageInterface
@@ -183,7 +183,7 @@ public function withoutHeader(string $name): MessageInterface
}

/**
* {@inheritDoc}
* @inheritDoc
*/
#[Override]
public function withBody(StreamInterface $body): MessageInterface
12 changes: 6 additions & 6 deletions src/Http/Request.php
Original file line number Diff line number Diff line change
@@ -199,7 +199,7 @@ public static function forDelete(Uri $uri, ?Headers $headers = null, string $ver
}

/**
* {@inheritDoc}
* @inheritDoc
*/
#[Override]
public function getMethod(): string
@@ -208,7 +208,7 @@ public function getMethod(): string
}

/**
* {@inheritDoc}
* @inheritDoc
*/
#[Override]
public function withMethod(string $method): self
@@ -222,7 +222,7 @@ public function withMethod(string $method): self
}

/**
* {@inheritDoc}
* @inheritDoc
*/
#[Override]
public function getUri(): UriInterface
@@ -231,7 +231,7 @@ public function getUri(): UriInterface
}

/**
* {@inheritDoc}
* @inheritDoc
*
* @throws InvalidArgumentException
*/
@@ -262,7 +262,7 @@ public function withUri(UriInterface $uri, bool $preserveHost = false): self
}

/**
* {@inheritDoc}
* @inheritDoc
*/
#[Override]
public function getRequestTarget(): string
@@ -275,7 +275,7 @@ public function getRequestTarget(): string
}

/**
* {@inheritDoc}
* @inheritDoc
*/
#[Override]
public function withRequestTarget(string $requestTarget): self
34 changes: 17 additions & 17 deletions src/Stream/Stream.php
Original file line number Diff line number Diff line change
@@ -107,7 +107,7 @@ public static function fromFile(string $file, string $mode = 'r+'): self
}

/**
* {@inheritDoc}
* @inheritDoc
*/
#[Override]
public function __toString(): string
@@ -123,7 +123,7 @@ public function __toString(): string
}

/**
* {@inheritDoc}
* @inheritDoc
*/
#[Override]
public function appendStream(AppendableStream $stream): int
@@ -146,7 +146,7 @@ public function appendStream(AppendableStream $stream): int
}

/**
* {@inheritDoc}
* @inheritDoc
*/
#[Override]
public function getResource(): mixed
@@ -155,7 +155,7 @@ public function getResource(): mixed
}

/**
* {@inheritDoc}
* @inheritDoc
*/
#[Override]
public function close(): void
@@ -168,7 +168,7 @@ public function close(): void
}

/**
* {@inheritDoc}
* @inheritDoc
*/
#[Override]
public function detach()
@@ -181,7 +181,7 @@ public function detach()
}

/**
* {@inheritDoc}
* @inheritDoc
*/
#[Override]
public function getSize(): ?int
@@ -196,7 +196,7 @@ public function getSize(): ?int
}

/**
* {@inheritDoc}
* @inheritDoc
*/
#[Override]
public function tell(): int
@@ -212,7 +212,7 @@ public function tell(): int
}

/**
* {@inheritDoc}
* @inheritDoc
*/
#[Override]
public function eof(): bool
@@ -226,7 +226,7 @@ public function eof(): bool
}

/**
* {@inheritDoc}
* @inheritDoc
*/
#[Override]
public function isSeekable(): bool
@@ -246,7 +246,7 @@ public function isSeekable(): bool
}

/**
* {@inheritDoc}
* @inheritDoc
*/
#[Override]
public function seek(int $offset, int $whence = SEEK_SET): void
@@ -260,7 +260,7 @@ public function seek(int $offset, int $whence = SEEK_SET): void
}

/**
* {@inheritDoc}
* @inheritDoc
*/
#[Override]
public function rewind(): void
@@ -275,7 +275,7 @@ public function rewind(): void
}

/**
* {@inheritDoc}
* @inheritDoc
*/
#[Override]
public function write(string $string): int
@@ -293,7 +293,7 @@ public function write(string $string): int
}

/**
* {@inheritDoc}
* @inheritDoc
*/
#[Override]
public function isWritable(): bool
@@ -314,7 +314,7 @@ public function isWritable(): bool
}

/**
* {@inheritDoc}
* @inheritDoc
*/
#[Override]
public function isReadable(): bool
@@ -335,7 +335,7 @@ public function isReadable(): bool
}

/**
* {@inheritDoc}
* @inheritDoc
*/
#[Override]
public function read(int $length): string
@@ -353,7 +353,7 @@ public function read(int $length): string
}

/**
* {@inheritDoc}
* @inheritDoc
*
* This function reads the complete stream from the CURRENT! file pointer. If you
* want ensure to read the complete stream use __toString() instead.
@@ -374,7 +374,7 @@ public function getContents(): string
}

/**
* {@inheritDoc}
* @inheritDoc
*/
#[Override]
public function getMetadata(?string $key = null): mixed
3 changes: 0 additions & 3 deletions tests/Integration/ResponseTest.php
Original file line number Diff line number Diff line change
@@ -24,9 +24,6 @@ protected function buildStream($data)
return Utils::streamFor($data);
}

/**
* {@inheritDoc}
*/
public function createSubject(): Response
{
return new Response(200, '1.1');
3 changes: 0 additions & 3 deletions tests/Integration/UriTest.php
Original file line number Diff line number Diff line change
@@ -14,9 +14,6 @@
#[\PHPUnit\Framework\Attributes\CoversClass(Uri::class)]
class UriTest extends TestCase
{
/**
* {@inheritDoc}
*/
public function createUri(string $uri)
{
return Uri::fromString($uri);
2 changes: 1 addition & 1 deletion tests/Unit/Client/ArtemeonHttpClientTest.php
Original file line number Diff line number Diff line change
@@ -60,7 +60,7 @@ class ArtemeonHttpClientTest extends TestCase
private ClientOptionsConverter | MockInterface $clientOptionsConverter;

/**
* {@inheritDoc}
* @inheritDoc
*/
#[Override]
protected function setUp(): void
2 changes: 1 addition & 1 deletion tests/Unit/Client/HttpClientLogDecoratorTest.php
Original file line number Diff line number Diff line change
@@ -42,7 +42,7 @@ class HttpClientLogDecoratorTest extends TestCase
private ClientOptions $clientOptions;

/**
* {@inheritDoc}
* @inheritDoc
*/
#[Override]
protected function setUp(): void
4 changes: 2 additions & 2 deletions tests/Unit/Stream/StreamTest.php
Original file line number Diff line number Diff line change
@@ -75,7 +75,7 @@ class StreamTest extends TestCase
private vfsStreamDirectory $filesystem;

/**
* {@inheritDoc}
* @inheritDoc
*/
#[Override]
protected function setUp(): void
@@ -92,7 +92,7 @@ protected function setUp(): void
}

/**
* {@inheritDoc}
* @inheritDoc
*/
#[Override]
protected function tearDown(): void

0 comments on commit e703bcd

Please sign in to comment.