Test dox (#491)

* Testdox

* Apply fixes from StyleCI

Co-authored-by: StyleCI Bot <[email protected]>

Author: DarkaOnLine

composer.json

@@ -58,6 +58,6 @@
   "minimum-stability": "dev",
   "prefer-stable": true,
   "scripts": {
-    "phpunit": "vendor/bin/phpunit"
+    "phpunit": "vendor/bin/phpunit --testdox"
   }
 }

phpunit.xml

@@ -1,5 +1,13 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="vendor/autoload.php" colors="true" convertErrorsToExceptions="true" convertNoticesToExceptions="true" convertWarningsToExceptions="true" stopOnFailure="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.5/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         colors="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         stopOnFailure="false"
+>
   <coverage>
     <include>
       <directory suffix=".php">src/</directory>

src/L5SwaggerFacade.php

@@ -7,6 +7,8 @@
 class L5SwaggerFacade extends Facade
 {
     /**
+     * @codeCoverageIgnore
+     *
      * @return string
      */
     protected static function getFacadeAccessor(): string

src/L5SwaggerServiceProvider.php

@@ -61,6 +61,8 @@ public function register()
     /**
      * Get the services provided by the provider.
      *
+     * @codeCoverageIgnore
+     *
      * @return array
      */
     public function provides()

tests/ConfigFactoryTest.php

@@ -4,12 +4,15 @@
 
 use L5Swagger\Exceptions\L5SwaggerException;
 
+/**
+ * @testdox Configuration factory
+ */
 class ConfigFactoryTest extends TestCase
 {
     /**
      * @test
      */
-    public function ifThrowsExceptionIfDocumentationConfigNotFound(): void
+    public function itThrowsExceptionIfDocumentationConfigNotFound(): void
     {
         $config = config('l5-swagger');
         unset($config['documentations']['default']);

tests/ConsoleTest.php

@@ -6,6 +6,9 @@
 use Illuminate\Support\Facades\Artisan;
 use L5Swagger\Exceptions\L5SwaggerException;
 
+/**
+ * @testdox Console commands
+ */
 class ConsoleTest extends TestCase
 {
     /**

tests/GeneratorTest.php

@@ -9,6 +9,9 @@
 use Symfony\Component\Yaml\Parser;
 use Symfony\Component\Yaml\Yaml;
 
+/**
+ * @testdox Generator
+ */
 class GeneratorTest extends TestCase
 {
     /** @test **/

tests/HelpersTest.php

@@ -4,6 +4,9 @@
 
 use L5Swagger\Exceptions\L5SwaggerException;
 
+/**
+ * @testdox Helpers
+ */
 class HelpersTest extends TestCase
 {
     /** @test */

tests/RoutesTest.php

@@ -7,6 +7,9 @@
 use L5Swagger\GeneratorFactory;
 use PHPUnit\Framework\MockObject\MockObject;
 
+/**
+ * @testdox Routes
+ */
 class RoutesTest extends TestCase
 {
     /** @test */

tests/SecurityDefinitionsTest.php

@@ -5,6 +5,9 @@
 use Illuminate\Filesystem\Filesystem;
 use L5Swagger\Exceptions\L5SwaggerException;
 
+/**
+ * @testdox Security definition
+ */
 class SecurityDefinitionsTest extends TestCase
 {
     /**