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

composer.json

@@ -13,6 +13,9 @@
     "require": {
         "php": "^8.0",
         "composer-runtime-api": "^2.0",
+        "symfony/config": "^5.0|^6.0",
+        "symfony/dependency-injection": "^5.0|^6.0",
+        "symfony/http-kernel": "^5.0|^6.0",
         "symfony/framework-bundle": "^5.0|^6.0",
         "yokai/batch": "^0.4.0"
     },

src/DependencyInjection/CompilerPass/RegisterJobsCompilerPass.php

@@ -10,7 +10,12 @@
 use Symfony\Component\DependencyInjection\Definition;
 use Symfony\Component\DependencyInjection\Reference;
 use Yokai\Batch\Bridge\Symfony\Framework\JobWithStaticNameInterface;
+use Yokai\Batch\Job\JobInterface;
+use Yokai\Batch\Registry\JobRegistry;
 
+/**
+ * Find tagged {@see JobInterface} and register these in {@see JobRegistry}.
+ */
 final class RegisterJobsCompilerPass implements CompilerPassInterface
 {
     /**

src/DependencyInjection/Configuration.php

@@ -8,6 +8,9 @@
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 use Symfony\Component\Config\Definition\ConfigurationInterface;
 
+/**
+ * Configuration for yokai/batch Symfony Bundle.
+ */
 final class Configuration implements ConfigurationInterface
 {
     /**

src/DependencyInjection/YokaiBatchExtension.php

@@ -20,6 +20,9 @@
 use Yokai\Batch\Storage\ListableJobExecutionStorageInterface;
 use Yokai\Batch\Storage\QueryableJobExecutionStorageInterface;
 
+/**
+ * Dependency injection extension for yokai/batch Symfony Bundle.
+ */
 final class YokaiBatchExtension extends Extension
 {
     /**

src/JobWithStaticNameInterface.php

@@ -4,6 +4,8 @@
 
 namespace Yokai\Batch\Bridge\Symfony\Framework;
 
+use Yokai\Batch\Registry\JobRegistry;
+
 /**
  * A job that implement this interface can define the associated job name via a static method.
  * This is very useful if you are registering jobs using PSR services registering.
@@ -12,5 +14,8 @@
  */
 interface JobWithStaticNameInterface
 {
+    /**
+     * The job name as it will be registered in the {@see JobRegistry}.
+     */
     public static function getJobName(): string;
 }

src/YokaiBatchBundle.php

@@ -8,6 +8,9 @@
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 use Yokai\Batch\Bridge\Symfony\Framework\DependencyInjection\CompilerPass\RegisterJobsCompilerPass;
 
+/**
+ * yokai/batch Symfony Bundle.
+ */
 final class YokaiBatchBundle extends Bundle
 {
     public function build(ContainerBuilder $container): void