Improve PHPDoc

webeweb · Jul 24, 2023 · dc358e5 · dc358e5
1 parent 19298a0
commit dc358e5
Show file tree

Hide file tree

Showing 28 changed files with 55 additions and 55 deletions.
diff --git a/src/adresse/Provider/ApiProvider.php b/src/adresse/Provider/ApiProvider.php
@@ -63,7 +63,7 @@ protected function appendArray(array &$post, string $name, array $data): void {
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getEndpointPath(): string {
         return self::ENDPOINT_PATH;

diff --git a/src/adresse/Request/ReverseCsvRequest.php b/src/adresse/Request/ReverseCsvRequest.php
@@ -27,7 +27,7 @@ class ReverseCsvRequest extends AbstractCsvRequest {
     const RESOURCE_PATH = "/reverse/csv/";
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getResourcePath(): string {
         return self::RESOURCE_PATH;

diff --git a/src/adresse/Request/ReverseRequest.php b/src/adresse/Request/ReverseRequest.php
@@ -47,7 +47,7 @@ public function __construct(float $lat = null, float $lon = null) {
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getResourcePath(): string {
         return self::RESOURCE_PATH;

diff --git a/src/adresse/Request/SearchCsvRequest.php b/src/adresse/Request/SearchCsvRequest.php
@@ -84,7 +84,7 @@ public function getColumns(): array {
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getResourcePath(): string {
         return self::RESOURCE_PATH;

diff --git a/src/adresse/Request/SearchRequest.php b/src/adresse/Request/SearchRequest.php
@@ -156,7 +156,7 @@ public function getPostcode(): ?string {
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getResourcePath(): string {
         return self::RESOURCE_PATH;

diff --git a/src/calendrier/Provider/ApiProvider.php b/src/calendrier/Provider/ApiProvider.php
@@ -33,7 +33,7 @@ class ApiProvider extends AbstractProvider {
     const ENDPOINT_PATH = "https://calendrier.api.gouv.fr";
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getEndpointPath(): string {
         return self::ENDPOINT_PATH;

diff --git a/src/calendrier/Request/JoursFeriesRequest.php b/src/calendrier/Request/JoursFeriesRequest.php
@@ -56,7 +56,7 @@ public function __construct(string $zone = null) {
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function deserializeResponse(string $rawResponse): AbstractResponse {
         return ResponseDeserializer::deserializeJoursFeriesResponse($rawResponse);
@@ -72,14 +72,14 @@ public function getAnnee(): ?int {
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getResourcePath(): string {
         return self::RESOURCE_PATH;
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getSubstituables(): array {
 
@@ -99,7 +99,7 @@ public function getZone(): ?string {
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function serializeRequest(): array {
         return [];

diff --git a/src/entreprise/Provider/APIv3Provider.php b/src/entreprise/Provider/APIv3Provider.php
@@ -26,7 +26,7 @@
 class APIv3Provider extends AbstractProvider {
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getVersion(): int {
         return 3;

diff --git a/src/entreprise/Provider/AbstractProvider.php b/src/entreprise/Provider/AbstractProvider.php
@@ -30,7 +30,7 @@ abstract class AbstractProvider extends BaseProvider {
     const ENDPOINT_PATH = "https://entreprise.data.gouv.fr";
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getEndpointPath(): string {
         return self::ENDPOINT_PATH;

diff --git a/src/entreprise/Request/EtablissementsRequest.php b/src/entreprise/Request/EtablissementsRequest.php
@@ -46,21 +46,21 @@ public function __construct(string $siret = null) {
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function deserializeResponse(string $rawResponse): AbstractResponse {
         return ResponseDeserializer::deserializeEtablissementsResponse($rawResponse);
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getResourcePath(): string {
         return self::RESOURCE_PATH;
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getSubstituables(): array {
 
@@ -70,7 +70,7 @@ public function getSubstituables(): array {
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function serializeRequest(): array {
         return RequestSerializer::serializeEtablissementsRequest($this);

diff --git a/src/entreprise/Request/UnitesLegalesRequest.php b/src/entreprise/Request/UnitesLegalesRequest.php
@@ -46,21 +46,21 @@ public function __construct(string $siren = null) {
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function deserializeResponse(string $rawResponse): AbstractResponse {
         return ResponseDeserializer::deserializeUnitesLegalesResponse($rawResponse);
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getResourcePath(): string {
         return self::RESOURCE_PATH;
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getSubstituables(): array {
 
@@ -70,7 +70,7 @@ public function getSubstituables(): array {
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function serializeRequest(): array {
         return RequestSerializer::serializeUnitesLegalesRequest($this);

diff --git a/src/geo/Provider/ApiProvider.php b/src/geo/Provider/ApiProvider.php
@@ -33,7 +33,7 @@ class ApiProvider extends AbstractProvider {
     const ENDPOINT_PATH = "https://geo.api.gouv.fr";
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getEndpointPath(): string {
         return self::ENDPOINT_PATH;

diff --git a/src/geo/Request/Commune/CommunesRequest.php b/src/geo/Request/Commune/CommunesRequest.php
@@ -37,21 +37,21 @@ class CommunesRequest extends AbstractRequest implements SubstituableRequestInte
     const RESOURCE_PATH = "/communes:code";
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function deserializeResponse(string $rawResponse): AbstractResponse {
         return ResponseDeserializer::deserializeCommunesResponse($rawResponse);
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getResourcePath(): string {
         return self::RESOURCE_PATH;
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getSubstituables(): array {
 
@@ -61,7 +61,7 @@ public function getSubstituables(): array {
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function serializeRequest(): array {
         return [];

diff --git a/src/geo/Request/Departement/CommunesRequest.php b/src/geo/Request/Departement/CommunesRequest.php
@@ -37,21 +37,21 @@ class CommunesRequest extends AbstractRequest implements SubstituableRequestInte
     const RESOURCE_PATH = "/departements/:code/communes";
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function deserializeResponse(string $rawResponse): AbstractResponse {
         return ResponseDeserializer::deserializeCommunesResponse($rawResponse);
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getResourcePath(): string {
         return self::RESOURCE_PATH;
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getSubstituables(): array {
 
@@ -61,7 +61,7 @@ public function getSubstituables(): array {
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function serializeRequest(): array {
         return [];

diff --git a/src/geo/Request/Departement/DepartementsRequest.php b/src/geo/Request/Departement/DepartementsRequest.php
@@ -32,21 +32,21 @@ class DepartementsRequest extends AbstractRequest implements SubstituableRequest
     const RESOURCE_PATH = "/departements:code";
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function deserializeResponse(string $rawResponse): AbstractResponse {
         return ResponseDeserializer::deserializeDepartementsResponse($rawResponse);
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getResourcePath(): string {
         return self::RESOURCE_PATH;
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getSubstituables(): array {
 
@@ -56,7 +56,7 @@ public function getSubstituables(): array {
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function serializeRequest(): array {
         return [];

diff --git a/src/geo/Request/Region/CommunesRequest.php b/src/geo/Request/Region/CommunesRequest.php
@@ -37,21 +37,21 @@ class CommunesRequest extends AbstractRequest implements SubstituableRequestInte
     const RESOURCE_PATH = "/regions/:code/communes";
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function deserializeResponse(string $rawResponse): AbstractResponse {
         return ResponseDeserializer::deserializeCommunesResponse($rawResponse);
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getResourcePath(): string {
         return self::RESOURCE_PATH;
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getSubstituables(): array {
 
@@ -61,7 +61,7 @@ public function getSubstituables(): array {
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function serializeRequest(): array {
         return [];

diff --git a/src/geo/Request/Region/DepartementsRequest.php b/src/geo/Request/Region/DepartementsRequest.php
@@ -32,21 +32,21 @@ class DepartementsRequest extends AbstractRequest implements SubstituableRequest
     const RESOURCE_PATH = "/regions/:code/departements";
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function deserializeResponse(string $rawResponse): AbstractResponse {
         return ResponseDeserializer::deserializeDepartementsResponse($rawResponse);
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getResourcePath(): string {
         return self::RESOURCE_PATH;
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getSubstituables(): array {
 
@@ -56,7 +56,7 @@ public function getSubstituables(): array {
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function serializeRequest(): array {
         return [];

diff --git a/src/geo/Request/Region/RegionsRequest.php b/src/geo/Request/Region/RegionsRequest.php
@@ -35,21 +35,21 @@ class RegionsRequest extends AbstractRequest implements SubstituableRequestInter
     const RESOURCE_PATH = "/regions:code";
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function deserializeResponse(string $rawResponse): AbstractResponse {
         return ResponseDeserializer::deserializeRegionsResponse($rawResponse);
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getResourcePath(): string {
         return self::RESOURCE_PATH;
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getSubstituables(): array {
 
@@ -59,7 +59,7 @@ public function getSubstituables(): array {
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function serializeRequest(): array {
         return [];

diff --git a/tests/adresse/AbstractTestCase.php b/tests/adresse/AbstractTestCase.php
@@ -31,7 +31,7 @@ abstract class AbstractTestCase extends TestCase {
     protected $logger;
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     protected function setUp(): void {
         parent::setUp();