✨ PHPDoc configuration

Signed-off-by: mathieu.brunot <[email protected]>

Author: madmath03

.dockerignore

@@ -81,6 +81,10 @@ typings/
 # next.js build output
 .next
 
+# ignore phpdoc cache directories
+.phpdoc/
+docs/
+
 ###> symfony/framework-bundle ###
 /app/.env.local
 /app/.env.local.php

.gitignore

@@ -90,6 +90,9 @@ typings/
 # next.js build output
 .next
 
+# ignore phpdoc cache directories
+.phpdoc/
+
 # Custom files
 .docker/
 build.date

README.md

@@ -23,6 +23,12 @@
 
 See GitHub Pages at [monogramm.github.io/vue-symfony-starter](https://monogramm.github.io/vue-symfony-starter/).
 
+You can generate the PHP documentation using PHPDocumentor:
+
+```bash
+docker run --rm -v "${PWD}:/data" phpdoc/phpdoc:3 run
+```
+
 ## :chart_with_upwards_trend: Changes
 
 All notable changes to this project will be documented in [CHANGELOG](./CHANGELOG.md) file.

phpdoc.dist.xml

@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<phpdocumentor
+        configVersion="3.0"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xmlns="https://www.phpdoc.org"
+        xsi:noNamespaceSchemaLocation="https://docs.phpdoc.org/latest/phpdoc.xsd"
+>
+  <paths>
+    <output>docs/php</output>
+    <cache>.phpdoc/cache</cache>
+  </paths>
+  <version number="latest">
+    <api>
+      <source dsn=".">
+        <path>app</path>
+      </source>
+      <ignore hidden="true" symlinks="true">
+        <path>app/tests/**/*</path>
+        <path>app/vendor/**/*</path>
+        <path>app/node_modules/**/*</path>
+        <path>app/var/**/*</path>
+        <path>app/public/build/**/*</path>
+        <path>app/bin/**/*</path>
+        <path>.phpdoc/**/*</path>
+      </ignore>
+      <markers>
+        <marker>TODO</marker>
+        <marker>FIXME</marker>
+        <marker>XXX</marker>
+      </markers>
+    </api>
+  </version>
+</phpdocumentor>