Improve PHPDoc

src/Factory/RequestFactory.php

@@ -32,7 +32,7 @@
 class RequestFactory {
 
     /**
-     * Creates a breach request.
+     * Create a breach request.
      *
      * @param BreachInterface $breach The breaches.
      * @return BreachRequest Returns the breach request.
@@ -46,7 +46,7 @@ public static function newBreachRequest(BreachInterface $breach): BreachRequest
     }
 
     /**
-     * Creates a breached account request.
+     * Create a breached account request.
      *
      * @param BreachedAccountInterface $breachedAccount The breached account.
      * @return BreachedAccountRequest Returns the breached account request.
@@ -63,7 +63,7 @@ public static function newBreachedAccountRequest(BreachedAccountInterface $breac
     }
 
     /**
-     * Creates a breaches request.
+     * Create a breaches request.
      *
      * @param BreachesInterface $breaches The breaches.
      * @return BreachesRequest Returns the breaches request.
@@ -77,7 +77,7 @@ public static function newBreachesRequest(BreachesInterface $breaches): Breaches
     }
 
     /**
-     * Creates a data classes request.
+     * Create a data classes request.
      *
      * @return DataClassesRequest Returns the data classes request.
      */
@@ -86,7 +86,7 @@ public static function newDataClassesRequest(): DataClassesRequest {
     }
 
     /**
-     * Creates a paste account request.
+     * Create a paste account request.
      *
      * @param PasteAccountInterface $pasteAccount The paste account.
      * @return PasteAccountRequest Returns the paste account request.
@@ -100,7 +100,7 @@ public static function newPasteAccountRequest(PasteAccountInterface $pasteAccoun
     }
 
     /**
-     * Creates a range request.
+     * Create a range request.
      *
      * @param RangeInterface $range The range.
      * @return RangeRequest Returns the range request.

src/Provider/APIv1Provider.php

@@ -33,7 +33,7 @@ public function getEndpointVersion(): string {
     }
 
     /**
-     * Sends a request.
+     * Send a request.
      *
      * @param BreachedAccountRequest $request The request.
      * @return BreachesResponse Returns the response.

src/Provider/APIv2Provider.php

@@ -34,7 +34,7 @@ public function getEndpointVersion(): string {
     }
 
     /**
-     * Sends a request.
+     * Send a request.
      *
      * @param AbstractRequest $request The request.
      * @return AbstractResponse Returns the response.

src/Provider/APIv3Provider.php

@@ -63,7 +63,7 @@ public function getEndpointVersion(): string {
     }
 
     /**
-     * Sends a request.
+     * Send a request.
      *
      * @param AbstractRequest $request The request.
      * @return AbstractResponse Returns the response.

src/Provider/AbstractProvider.php

@@ -47,7 +47,7 @@ public function __construct(LoggerInterface $logger = null) {
     }
 
     /**
-     * Builds the configuration.
+     * Build the configuration.
      *
      * @param string $host The host.
      * @param string|null $apiKey The API key.
@@ -73,7 +73,7 @@ private function buildConfiguration(string $host, string $apiKey = null): array
     }
 
     /**
-     * Calls the API.
+     * Call the API.
      *
      * @param AbstractRequest $request The request.
      * @param array $queryData The query data.

src/Request/AbstractRequest.php

@@ -32,15 +32,15 @@ public function __construct() {
     }
 
     /**
-     * Deserializes a response.
+     * Deserialize a response.
      *
      * @param string $rawResponse The raw response.
      * @return AbstractResponse Returns the deserialized response.
      */
     abstract public function deserializeResponse(string $rawResponse): AbstractResponse;
 
     /**
-     * Serializes this request.
+     * Serialize this request.
      *
      * @return array Returns this serialized request.
      * @throws InvalidArgumentException Throws an invalid argument exception if a mandatory parameter is missing.

src/Serializer/RequestSerializer.php

@@ -25,7 +25,7 @@
 class RequestSerializer {
 
     /**
-     * Serializes a breached account request.
+     * Serialize a breached account request.
      *
      * @param BreachedAccountRequest $request The breached account request.
      * @return array Returns the serialized breached account request.
@@ -42,7 +42,7 @@ public static function serializeBreachedAccountRequest(BreachedAccountRequest $r
     }
 
     /**
-     * Serializes a breaches request.
+     * Serialize a breaches request.
      *
      * @param BreachesRequest $request The breaches request.
      * @return array Returns the serialized breaches request.

src/Serializer/ResponseDeserializer.php

@@ -33,7 +33,7 @@
 class ResponseDeserializer {
 
     /**
-     * Cleans a raw response.
+     * Clean a raw response.
      *
      * @param string $rawResponse The raw response.
      * @return string Returns the cleaned raw response.
@@ -47,7 +47,7 @@ protected static function cleanResponse(string $rawResponse): string {
     }
 
     /**
-     * Deserializes a breach.
+     * Deserialize a breach.
      *
      * @param array $data The data.
      * @return Breach Returns a breach.
@@ -80,7 +80,7 @@ protected static function deserializeBreach(array $data): Breach {
     }
 
     /**
-     * Deserializes a breaches response.
+     * Deserialize a breaches response.
      *
      * @param string $rawResponse The raw response.
      * @return BreachesResponse Returns the breaches response.
@@ -113,7 +113,7 @@ public static function deserializeBreachesResponse(string $rawResponse): Breache
     }
 
     /**
-     * Deserializes a data class.
+     * Deserialize a data class.
      *
      * @param string $rawResponse The raw response.
      * @return DataClass Returns a data class.
@@ -127,7 +127,7 @@ protected static function deserializeDataClass(string $rawResponse): DataClass {
     }
 
     /**
-     * Deserializes a data classes response.
+     * Deserialize a data classes response.
      *
      * @param string $rawResponse The raw response.
      * @return DataClassesResponse Returns the data classes response.
@@ -150,7 +150,7 @@ public static function deserializeDataClassesResponse(string $rawResponse): Data
     }
 
     /**
-     * Deserializes a paste.
+     * Deserialize a paste.
      *
      * @param array $data The data.
      * @return Paste Returns the paste.
@@ -170,7 +170,7 @@ protected static function deserializePaste(array $data): Paste {
     }
 
     /**
-     * Deserializes a pastes response.
+     * Deserialize a pastes response.
      *
      * @param string $rawResponse The raw response.
      * @return PastesResponse Returns the pastes response.
@@ -194,7 +194,7 @@ public static function deserializePastesResponse(string $rawResponse): PastesRes
     }
 
     /**
-     * Deserializes a range.
+     * Deserialize a range.
      *
      * @param string $rawResponse The raw response.
      * @return Range Returns a range.
@@ -215,7 +215,7 @@ protected static function deserializeRange(string $rawResponse): Range {
     }
 
     /**
-     * Deserializes a ranges response.
+     * Deserialize a ranges response.
      *
      * @param string $rawResponse The raw response.
      * @return RangesResponse Returns the ranges response.

tests/Api/RequestInterfaceTest.php

@@ -23,7 +23,7 @@
 class RequestInterfaceTest extends AbstractTestCase {
 
     /**
-     * Tests __construct()
+     * Test __construct()
      *
      * @return void
      */

tests/Api/ResponseInterfaceTest.php

@@ -23,7 +23,7 @@
 class ResponseInterfaceTest extends AbstractTestCase {
 
     /**
-     * Tests __construct()
+     * Test __construct()
      *
      * @return void
      */

tests/Factory/RequestFactoryTest.php

@@ -29,7 +29,7 @@
 class RequestFactoryTest extends AbstractTestCase {
 
     /**
-     * Tests newBreachRequest()
+     * Test newBreachRequest()
      *
      * @return void
      */
@@ -42,7 +42,7 @@ public function testNewBreachRequest(): void {
     }
 
     /**
-     * Tests newBreachedAccountRequest()
+     * Test newBreachedAccountRequest()
      *
      * @return void
      */
@@ -58,7 +58,7 @@ public function testNewBreachedAccountRequest(): void {
     }
 
     /**
-     * Tests newBreachesRequest()
+     * Test newBreachesRequest()
      *
      * @return void
      */
@@ -71,7 +71,7 @@ public function testNewBreachesRequest(): void {
     }
 
     /**
-     * Tests newDataClassesRequest()
+     * Test newDataClassesRequest()
      *
      * @return void
      */
@@ -82,7 +82,7 @@ public function testNewDataClassesRequest(): void {
     }
 
     /**
-     * Tests newPasteAccountRequest()
+     * Test newPasteAccountRequest()
      *
      * @return void
      */
@@ -95,7 +95,7 @@ public function testNewPasteAccountRequest(): void {
     }
 
     /**
-     * Tests newRangeRequest()
+     * Test newRangeRequest()
      *
      * @return void
      */

tests/Model/BreachTest.php

@@ -25,7 +25,7 @@
 class BreachTest extends AbstractTestCase {
 
     /**
-     * Tests setAddedDate()
+     * Test setAddedDate()
      *
      * @return void
      * @throws Throwable Throws an exception if an error occurs.
@@ -41,7 +41,7 @@ public function testSetAddedDate(): void {
     }
 
     /**
-     * Tests setBreachDate()
+     * Test setBreachDate()
      *
      * @return void
      * @throws Throwable Throws an exception if an error occurs.
@@ -57,7 +57,7 @@ public function testSetBreachDate(): void {
     }
 
     /**
-     * Tests setDataClasses()
+     * Test setDataClasses()
      *
      * @return void
      */
@@ -70,7 +70,7 @@ public function testSetDataClasses(): void {
     }
 
     /**
-     * Tests setFabricated()
+     * Test setFabricated()
      *
      * @return void
      */
@@ -83,7 +83,7 @@ public function testSetFabricated(): void {
     }
 
     /**
-     * Tests setModifiedDate()
+     * Test setModifiedDate()
      *
      * @return void
      * @throws Throwable Throws an exception if an error occurs.
@@ -99,7 +99,7 @@ public function testSetModifiedDate(): void {
     }
 
     /**
-     * Tests setPwnCount()
+     * Test setPwnCount()
      *
      * @return void
      */
@@ -112,7 +112,7 @@ public function testSetPwnCount(): void {
     }
 
     /**
-     * Tests setRetired()
+     * Test setRetired()
      *
      * @return void
      */
@@ -125,7 +125,7 @@ public function testSetRetired(): void {
     }
 
     /**
-     * Tests setSensitive()
+     * Test setSensitive()
      *
      * @return void
      */
@@ -138,7 +138,7 @@ public function testSetSensitive(): void {
     }
 
     /**
-     * Tests setSpamList()
+     * Test setSpamList()
      *
      * @return void
      */
@@ -151,7 +151,7 @@ public function testSetSpamList(): void {
     }
 
     /**
-     * Tests setVerified()
+     * Test setVerified()
      *
      * @return void
      */
@@ -164,7 +164,7 @@ public function testSetVerified(): void {
     }
 
     /**
-     * Tests __construct()
+     * Test __construct()
      *
      * @return void
      */

tests/Model/DataClassTest.php

@@ -23,7 +23,7 @@
 class DataClassTest extends AbstractTestCase {
 
     /**
-     * Tests __construct()
+     * Test __construct()
      *
      * @return void
      */