Improve PHPDoc

webeweb · Jul 24, 2023 · 6fd8349 · 6fd8349
1 parent 51cae15
commit 6fd8349
Show file tree

Hide file tree

Showing 11 changed files with 27 additions and 27 deletions.
diff --git a/src/Provider/APIv1Provider.php b/src/Provider/APIv1Provider.php
@@ -26,7 +26,7 @@
 class APIv1Provider extends AbstractProvider {
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getEndpointVersion(): string {
         return "";

diff --git a/src/Provider/APIv2Provider.php b/src/Provider/APIv2Provider.php
@@ -27,7 +27,7 @@
 class APIv2Provider extends AbstractProvider {
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getEndpointVersion(): string {
         return "/v2";

diff --git a/src/Provider/APIv3Provider.php b/src/Provider/APIv3Provider.php
@@ -56,7 +56,7 @@ public function getApiKey(): ?string {
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getEndpointVersion(): string {
         return "/v3";

diff --git a/src/Request/BreachRequest.php b/src/Request/BreachRequest.php
@@ -34,21 +34,21 @@ class BreachRequest extends AbstractRequest implements SubstituableRequestInterf
     const BREACH_RESOURCE_PATH = "/breach/{name}";
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function deserializeResponse(string $rawResponse): AbstractResponse {
         return ResponseDeserializer::deserializeBreachesResponse($rawResponse);
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getResourcePath(): string {
         return self::BREACH_RESOURCE_PATH;
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getSubstituables(): array {
 
@@ -58,7 +58,7 @@ public function getSubstituables(): array {
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function serializeRequest(): array {
         return [];

diff --git a/src/Request/BreachedAccountRequest.php b/src/Request/BreachedAccountRequest.php
@@ -56,7 +56,7 @@ public function __construct() {
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function deserializeResponse(string $rawResponse): AbstractResponse {
         return ResponseDeserializer::deserializeBreachesResponse($rawResponse);
@@ -72,14 +72,14 @@ public function getIncludeUnverified(): ?bool {
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getResourcePath(): string {
         return self::BREACHED_ACCOUNT_RESOURCE_PATH;
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getSubstituables(): array {
 
@@ -98,7 +98,7 @@ public function getTruncateResponse(): ?bool {
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function serializeRequest(): array {
         return RequestSerializer::serializeBreachedAccountRequest($this);

diff --git a/src/Request/BreachesRequest.php b/src/Request/BreachesRequest.php
@@ -34,21 +34,21 @@ class BreachesRequest extends AbstractRequest {
     const BREACHES_RESOURCE_PATH = "/breaches";
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function deserializeResponse(string $rawResponse): AbstractResponse {
         return ResponseDeserializer::deserializeBreachesResponse($rawResponse);
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getResourcePath(): string {
         return self::BREACHES_RESOURCE_PATH;
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function serializeRequest(): array {
         return RequestSerializer::serializeBreachesRequest($this);

diff --git a/src/Request/DataClassesRequest.php b/src/Request/DataClassesRequest.php
@@ -30,21 +30,21 @@ class DataClassesRequest extends AbstractRequest {
     const DATA_CLASSES_RESOURCE_PATH = "/dataclasses";
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function deserializeResponse(string $rawResponse): AbstractResponse {
         return ResponseDeserializer::deserializeDataClassesResponse($rawResponse);
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getResourcePath(): string {
         return self::DATA_CLASSES_RESOURCE_PATH;
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function serializeRequest(): array {
         return [];

diff --git a/src/Request/PasteAccountRequest.php b/src/Request/PasteAccountRequest.php
@@ -34,21 +34,21 @@ class PasteAccountRequest extends AbstractRequest implements SubstituableRequest
     const PASTE_ACCOUNT_RESOURCE_PATH = "/pasteaccount/{account}";
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function deserializeResponse(string $rawResponse): AbstractResponse {
         return ResponseDeserializer::deserializePastesResponse($rawResponse);
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getResourcePath(): string {
         return self::PASTE_ACCOUNT_RESOURCE_PATH;
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getSubstituables(): array {
 
@@ -58,7 +58,7 @@ public function getSubstituables(): array {
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function serializeRequest(): array {
         return [];

diff --git a/src/Request/RangeRequest.php b/src/Request/RangeRequest.php
@@ -34,21 +34,21 @@ class RangeRequest extends AbstractRequest implements SubstituableRequestInterfa
     const RANGE_RESOURCE_PATH = "/range/{hash}";
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function deserializeResponse(string $rawResponse): AbstractResponse {
         return ResponseDeserializer::deserializeRangesResponse($rawResponse);
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getResourcePath(): string {
         return self::RANGE_RESOURCE_PATH;
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getSubstituables(): array {
 
@@ -58,7 +58,7 @@ public function getSubstituables(): array {
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function serializeRequest(): array {
         return [];

diff --git a/tests/Fixtures/Provider/TestProvider.php b/tests/Fixtures/Provider/TestProvider.php
@@ -22,7 +22,7 @@
 class TestProvider extends AbstractProvider {
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getEndpointVersion(): string {
         return "";

diff --git a/tests/Fixtures/Request/TestRequest.php b/tests/Fixtures/Request/TestRequest.php
@@ -22,7 +22,7 @@
 class TestRequest extends AbstractRequest {
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getResourcePath(): string {
         return "";