Updating PHPDoc.

Author: cyrilverloop

src/Puzzle.php

@@ -4,9 +4,16 @@
 
 namespace CyrilVerloop\Codingame;
 
+/**
+ * A base class for puzzle.
+ */
 abstract class Puzzle
 {
     // Methods :
 
+    /**
+     * Execute the code of the puzzle.
+     * @param resource $stdin the resource to get the datas from.
+     */
     abstract public function execute($stdin): void;
 }

src/Training/Easy/ASCIIArt/ASCIIArt.php

@@ -6,6 +6,9 @@
 
 use CyrilVerloop\Codingame\Puzzle;
 
+/**
+ * The "ASCII Art" puzzle.
+ */
 class ASCIIArt extends Puzzle
 {
     // Methods :

src/Training/Easy/Defibrillators/Defibrillators.php

@@ -6,6 +6,9 @@
 
 use CyrilVerloop\Codingame\Puzzle;
 
+/**
+ * The "Defibrillators" puzzle.
+ */
 class Defibrillators extends Puzzle
 {
     // Methods :

src/Training/Easy/HorseRacingDuals/HorseRacingDuals.php

@@ -6,6 +6,9 @@
 
 use CyrilVerloop\Codingame\Puzzle;
 
+/**
+ * The "Horse-racing Duals" puzzle.
+ */
 class HorseRacingDuals extends Puzzle
 {
     // Methods :

src/Training/Easy/MIMEType/MIMEType.php

@@ -6,6 +6,9 @@
 
 use CyrilVerloop\Codingame\Puzzle;
 
+/**
+ * The "MIME Type" puzzle.
+ */
 class MIMEType extends Puzzle
 {
     // Methods :

src/Training/Easy/Temperatures/Temperatures.php

@@ -6,6 +6,9 @@
 
 use CyrilVerloop\Codingame\Puzzle;
 
+/**
+ * The "Temperatures" puzzle.
+ */
 class Temperatures extends Puzzle
 {
     // Methods :

src/Training/Easy/Unary/Unary.php

@@ -6,6 +6,9 @@
 
 use CyrilVerloop\Codingame\Puzzle;
 
+/**
+ * The "Unary" puzzle.
+ */
 class Unary extends Puzzle
 {
     // Methods :

tests/PuzzleTest.php

@@ -7,22 +7,22 @@
 use PHPUnit\Framework\TestCase;
 
 /**
- * @coversDefaultClass \CyrilVerloop\Codingame\Training\Easy\HorseRacingDuals\HorseRacingDuals
+ * Base class for testing puzzles.
  */
 abstract class PuzzleTest extends TestCase
 {
     // Properties :
 
-    /**
-     * @var \CyrilVerloop\Codingame\Puzzle the puzzle.
-     */
+    /** @var \CyrilVerloop\Codingame\Puzzle the puzzle. */
     protected $puzzle;
 
 
     // Methods :
 
     /**
-     * Expects execute to output answer.
+     * Expects `execute()` to output answer.
+     * @param string $filename the file name.
+     * @param string $expectedAnswer the expected answer.
      */
     protected function expectExecuteOutputAnswer(string $filename, string $expectedAnswer): void
     {

tests/Training/Easy/ASCIIArt/ASCIIArtTest.php

@@ -8,7 +8,9 @@
 use CyrilVerloop\Codingame\Training\Easy\ASCIIArt\ASCIIArt;
 
 /**
- * @coversDefaultClass \CyrilVerloop\Codingame\Training\Easy\ASCIIArt\ASCIIArt
+ * Tests for the "ASCII Art" puzzle.
+ *
+ * @covers \CyrilVerloop\Codingame\Training\Easy\ASCIIArt\ASCIIArt
  * @group ASCIIArt
  */
 final class ASCIIArtTest extends PuzzleTest
@@ -26,7 +28,6 @@ public function setUp(): void
     /**
      * Test that the code can be executed for "Test only one letter: E".
      *
-     * @covers ::execute
      * @group ASCIIArt_onlyOneLetterE
      */
     public function testCanExecuteTestOnlyOneLetterE(): void
@@ -40,7 +41,6 @@ public function testCanExecuteTestOnlyOneLetterE(): void
     /**
      * Test that the code can be executed for "Test MANHATTAN".
      *
-     * @covers ::execute
      * @group ASCIIArt_testMANHATTAN
      */
     public function testCanExecuteTestMANHATTAN(): void
@@ -54,7 +54,6 @@ public function testCanExecuteTestMANHATTAN(): void
     /**
      * Test that the code can be executed for "Test ManhAtTan".
      *
-     * @covers ::execute
      * @group ASCIIArt_testManhAtTan
      */
     public function testCanExecuteTestDifferentCaseManhAtTan(): void
@@ -68,7 +67,6 @@ public function testCanExecuteTestDifferentCaseManhAtTan(): void
     /**
      * Test that the code can be executed for "Test M@NH@TT@N".
      *
-     * @covers ::execute
      * @group ASCIIArt_testM@NH@TT@N
      */
     public function testCanExecuteTestMatNHatTTatN(): void
@@ -82,7 +80,6 @@ public function testCanExecuteTestMatNHatTTatN(): void
     /**
      * Test that the code can be executed for "MANHATTAN with another ASCII representation".
      *
-     * @covers ::execute
      * @group ASCIIArt_MANHATTANWithAnotherASCIIRepresentation
      */
     public function testCanExecuteMANHATTANWithAnotherASCIIRepresentation(): void
@@ -96,7 +93,6 @@ public function testCanExecuteMANHATTANWithAnotherASCIIRepresentation(): void
     /**
      * Test that the code can be executed for "Test MAN HAT TAN".
      *
-     * @covers ::execute
      * @group ASCIIArt_TestMAN_HAT_TAN
      */
     public function testCanExecuteTestMAN_HAT_TAN(): void

tests/Training/Easy/Defibrillators/DefibrillatorsTest.php

@@ -8,7 +8,9 @@
 use CyrilVerloop\Codingame\Training\Easy\Defibrillators\Defibrillators;
 
 /**
- * @coversDefaultClass \CyrilVerloop\Codingame\Training\Easy\Defibrillators\Defibrillators
+ * Tests for the "Defibrillators" puzzle.
+ *
+ * @covers \CyrilVerloop\Codingame\Training\Easy\Defibrillators\Defibrillators
  * @group defibrillators
  */
 final class DefibrillatorsTest extends PuzzleTest
@@ -26,7 +28,6 @@ public function setUp(): void
     /**
      * Test that the code can be executed for "Example".
      *
-     * @covers ::execute
      * @group defibrillators_example
      */
     public function testCanExecuteExample(): void
@@ -40,7 +41,6 @@ public function testCanExecuteExample(): void
     /**
      * Test that the code can be executed for "Exact position".
      *
-     * @covers ::execute
      * @group defibrillators_exactPosition
      */
     public function testCanExecuteExactPosition(): void
@@ -54,7 +54,6 @@ public function testCanExecuteExactPosition(): void
     /**
      * Test that the code can be executed for "Complete file".
      *
-     * @covers ::execute
      * @group defibrillators_completeFile
      */
     public function testCanExecuteCompleteFile(): void
@@ -68,7 +67,6 @@ public function testCanExecuteCompleteFile(): void
     /**
      * Test that the code can be executed for "Complete file 2".
      *
-     * @covers ::execute
      * @group defibrillators_completeFile2
      */
     public function testCanExecuteCompleteFile2(): void

tests/Training/Easy/HorseRacingDuals/HorseRacingDualsTest.php

@@ -8,7 +8,9 @@
 use CyrilVerloop\Codingame\Training\Easy\HorseRacingDuals\HorseRacingDuals;
 
 /**
- * @coversDefaultClass \CyrilVerloop\Codingame\Training\Easy\HorseRacingDuals\HorseRacingDuals
+ * Tests for the "Horse-racing Duals" puzzle.
+ *
+ * @covers \CyrilVerloop\Codingame\Training\Easy\HorseRacingDuals\HorseRacingDuals
  * @group horseRacingDuals
  */
 final class HorseRacingDualsTest extends PuzzleTest
@@ -26,7 +28,6 @@ public function setUp(): void
     /**
      * Test that the code can be executed for "Simple case".
      *
-     * @covers ::execute
      * @group horseRacingDuals_simpleCase
      */
     public function testCanExecuteSimpleCase(): void
@@ -40,7 +41,6 @@ public function testCanExecuteSimpleCase(): void
     /**
      * Test that the code can be executed for "Horses in any order".
      *
-     * @covers ::execute
      * @group horseRacingDuals_horsesInAnyOrder
      */
     public function testCanExecuteHorsesInAnyOrder(): void
@@ -54,7 +54,6 @@ public function testCanExecuteHorsesInAnyOrder(): void
     /**
      * Test that the code can be executed for "Many horses".
      *
-     * @covers ::execute
      * @group horseRacingDuals_manyHorses
      */
     public function testCanExecuteManyHorses(): void

tests/Training/Easy/MIMEType/MIMETypeTest.php

@@ -8,7 +8,9 @@
 use CyrilVerloop\Codingame\Training\Easy\MIMEType\MIMEType;
 
 /**
- * @coversDefaultClass \CyrilVerloop\Codingame\Training\Easy\MIMEType\MIMEType
+ * Tests for the "MIME Type" puzzle.
+ *
+ * @covers \CyrilVerloop\Codingame\Training\Easy\MIMEType\MIMEType
  * @group MIMEType
  */
 final class MIMETypeTest extends PuzzleTest
@@ -26,7 +28,6 @@ public function setUp(): void
     /**
      * Test that the code can be executed for "Simple example".
      *
-     * @covers ::execute
      * @group MIMEType_simpleExample
      */
     public function testCanExecuteSimpleExample(): void
@@ -40,7 +41,6 @@ public function testCanExecuteSimpleExample(): void
     /**
      * Test that the code can be executed for "Unknown MIME types".
      *
-     * @covers ::execute
      * @group MIMEType_unknownMIMETypes
      */
     public function testCanExecuteUnknownMIMETypes(): void
@@ -54,7 +54,6 @@ public function testCanExecuteUnknownMIMETypes(): void
     /**
      * Test that the code can be executed for "Correct division of the extension".
      *
-     * @covers ::execute
      * @group MIMEType_correctDivisionOfTheExtension
      */
     public function testCanExecuteCorrectDivisionOfTheExtension(): void
@@ -68,7 +67,6 @@ public function testCanExecuteCorrectDivisionOfTheExtension(): void
     /**
      * Test that the code can be executed for "Consideration of the case (upper or lower)".
      *
-     * @covers ::execute
      * @group MIMEType_considerationOfTheCase
      */
     public function testCanExecuteConsiderationOfTheCase(): void
@@ -82,7 +80,6 @@ public function testCanExecuteConsiderationOfTheCase(): void
     /**
      * Test that the code can be executed for "Large dataset".
      *
-     * @covers ::execute
      * @group MIMEType_largeDataset
      */
     public function testCanExecuteLargeDataset(): void

tests/Training/Easy/Temperatures/TemperaturesTest.php

@@ -8,7 +8,9 @@
 use CyrilVerloop\Codingame\Training\Easy\Temperatures\Temperatures;
 
 /**
- * @coversDefaultClass \CyrilVerloop\Codingame\Training\Easy\Temperatures\Temperatures
+ * Tests for the "Temperatures" puzzle.
+ *
+ * @covers \CyrilVerloop\Codingame\Training\Easy\Temperatures\Temperatures
  * @group temperatures
  */
 final class TemperaturesTest extends PuzzleTest
@@ -26,7 +28,6 @@ public function setUp(): void
     /**
      * Test that the code can be executed for "Simple test case".
      *
-     * @covers ::execute
      * @group unary_simpleTestCase
      */
     public function testCanExecuteSimpleTestCase(): void
@@ -40,7 +41,6 @@ public function testCanExecuteSimpleTestCase(): void
     /**
      * Test that the code can be executed for "Only negative numbers".
      *
-     * @covers ::execute
      * @group unary_onlyNegativeNumbers
      */
     public function testCanExecuteOnlyNegativeNumbers(): void
@@ -54,7 +54,6 @@ public function testCanExecuteOnlyNegativeNumbers(): void
     /**
      * Test that the code can be executed for "Choose the right temperature".
      *
-     * @covers ::execute
      * @group unary_chooseTheRightTemperature
      */
     public function testCanExecuteChooseTheRightTemperature(): void
@@ -68,7 +67,6 @@ public function testCanExecuteChooseTheRightTemperature(): void
     /**
      * Test that the code can be executed for "Choose the right temperature 2".
      *
-     * @covers ::execute
      * @group unary_chooseTheRightTemperature2
      */
     public function testCanExecuteChooseTheRightTemperature2(): void
@@ -82,7 +80,6 @@ public function testCanExecuteChooseTheRightTemperature2(): void
     /**
      * Test that the code can be executed for "Complex test case".
      *
-     * @covers ::execute
      * @group unary_complexTestCase
      */
     public function testCanExecuteComplexTestCase(): void
@@ -96,7 +93,6 @@ public function testCanExecuteComplexTestCase(): void
     /**
      * Test that the code can be executed for "No temperature".
      *
-     * @covers ::execute
      * @group unary_noTemperature
      */
     public function testCanExecuteNoTemperature(): void

tests/Training/Easy/Unary/UnaryTest.php

@@ -8,7 +8,9 @@
 use CyrilVerloop\Codingame\Training\Easy\Unary\Unary;
 
 /**
- * @coversDefaultClass \CyrilVerloop\Codingame\Training\Easy\Unary\Unary
+ * Tests for the "Unary" puzzle.
+ *
+ * @covers \CyrilVerloop\Codingame\Training\Easy\Unary\Unary
  * @group unary
  */
 final class UnaryTest extends PuzzleTest
@@ -26,7 +28,6 @@ public function setUp(): void
     /**
      * Test that the code can be executed for "Character C".
      *
-     * @covers ::execute
      * @group unary_characterC
      */
     public function testCanExecuteCharacterC(): void
@@ -40,7 +41,6 @@ public function testCanExecuteCharacterC(): void
     /**
      * Test that the code can be executed for "Message CC".
      *
-     * @covers ::execute
      * @group unary_messageCC
      */
     public function testCanExecuteMessageCC(): void
@@ -54,7 +54,6 @@ public function testCanExecuteMessageCC(): void
     /**
      * Test that the code can be executed for "Character %".
      *
-     * @covers ::execute
      * @group unary_characterPercentSign
      */
     public function testCanExecuteCharacterPercentSign(): void
@@ -68,7 +67,6 @@ public function testCanExecuteCharacterPercentSign(): void
     /**
      * Test that the code can be executed for "Message from Chuck Norris".
      *
-     * @covers ::execute
      * @group unary_messageFromChuckNorris
      */
     public function testCanExecuteMessageFromChuckNorris(): void