Add conventions around PHP code in the project (#68)

* Add convention tests over packages definitions

* Add conventions around classes docblocks

* Add conventions around public method docblocks

Author: yann-eugone

src/CommandRunner.php

@@ -7,6 +7,9 @@
 use Symfony\Component\Console\Input\ArrayInput;
 use Symfony\Component\Process\PhpExecutableFinder;
 
+/**
+ * Utility class that knows how to run command asynchronously.
+ */
 class CommandRunner
 {
     private string $consolePath;
@@ -25,6 +28,8 @@ public function __construct(
     }
 
     /**
+     * Run a command asynchronously.
+     *
      * @phpstan-param array<string, mixed> $arguments
      */
     public function runAsync(string $commandName, string $logFilename, array $arguments = []): void

src/RunCommandJobLauncher.php

@@ -13,7 +13,7 @@
 /**
  * This {@see JobLauncherInterface} will execute job via an asynchronous symfony command.
  *
- * Example, if you call {@see RunCommandJobLauncher::launch('import', ['foo'=>'bar'])},
+ * Example, if you call RunCommandJobLauncher::launch('import', ['foo'=>'bar']),
  * this command will run (with absolute pathes) :
  *
  *      php bin/console yokai:batch:run import '{"foo":"bar"}' >> var/log/batch_execute.log 2>&1 &

src/RunJobCommand.php

@@ -13,8 +13,12 @@
 use Yokai\Batch\Exception\UnexpectedValueException;
 use Yokai\Batch\Job\JobExecutionAccessor;
 use Yokai\Batch\Job\JobExecutor;
+use Yokai\Batch\Job\JobInterface;
 use Yokai\Batch\JobExecution;
 
+/**
+ * Execute any {@see JobInterface} within your CLI.
+ */
 final class RunJobCommand extends Command
 {
     protected static $defaultName = 'yokai:batch:run';