From 8c135fb29c4eac36a6dd1f715c107ee68c0973d2 Mon Sep 17 00:00:00 2001
From: Katrina Knight <kat.knight@newgaea.net>
Date: Fri, 3 Sep 2021 17:10:42 +0100
Subject: [PATCH] Added Automatic PHPDoc generation

---
 .github/workflows/documentation.yml | 20 ++++++++++++++++++++
 .gitignore                          |  1 +
 phpdoc.dist.xml                     | 19 +++++++++++++++++++
 3 files changed, 40 insertions(+)
 create mode 100644 .github/workflows/documentation.yml
 create mode 100644 phpdoc.dist.xml

diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
new file mode 100644
index 0000000..16f50eb
--- /dev/null
+++ b/.github/workflows/documentation.yml
@@ -0,0 +1,20 @@
+name: Documentation
+
+on:
+  push:
+    branches: [ master ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: PhpDocumentor
+        uses: katrinaas/actions-phpDocumentor@v1
+      - name: Save the changes
+        uses: EndBug/add-and-commit@v7
+        with:
+          add: "docs"
+          message: Adding generated Documentation
\ No newline at end of file
diff --git a/.gitignore b/.gitignore
index 2ff732f..1640e17 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,6 +1,7 @@
 ### Project related
 vendor/
 .idea/
+build/
 
 logs/*
 
diff --git a/phpdoc.dist.xml b/phpdoc.dist.xml
new file mode 100644
index 0000000..1072e5e
--- /dev/null
+++ b/phpdoc.dist.xml
@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<phpdocumentor
+        configVersion="3"
+        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/</output>
+        <cache>build/cache</cache>
+    </paths>
+    <version number="latest">
+        <api>
+            <source dsn=".">
+                <path>src</path>
+            </source>
+        </api>
+    </version>
+</phpdocumentor>
\ No newline at end of file