Skip to content

Commit 8c135fb

Browse files
GaeaKatVassyli
authored andcommitted
Added Automatic PHPDoc generation
1 parent 5e6f132 commit 8c135fb

File tree

3 files changed

+40
-0
lines changed

3 files changed

+40
-0
lines changed

.github/workflows/documentation.yml

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Documentation
2+
3+
on:
4+
push:
5+
branches: [ master ]
6+
7+
jobs:
8+
build:
9+
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
- uses: actions/checkout@v2
14+
- name: PhpDocumentor
15+
uses: katrinaas/actions-phpDocumentor@v1
16+
- name: Save the changes
17+
uses: EndBug/add-and-commit@v7
18+
with:
19+
add: "docs"
20+
message: Adding generated Documentation

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
### Project related
22
vendor/
33
.idea/
4+
build/
45

56
logs/*
67

phpdoc.dist.xml

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<?xml version="1.0" encoding="UTF-8" ?>
2+
<phpdocumentor
3+
configVersion="3"
4+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
5+
xmlns="https://www.phpdoc.org"
6+
xsi:noNamespaceSchemaLocation="https://docs.phpdoc.org/latest/phpdoc.xsd"
7+
>
8+
<paths>
9+
<output>docs/</output>
10+
<cache>build/cache</cache>
11+
</paths>
12+
<version number="latest">
13+
<api>
14+
<source dsn=".">
15+
<path>src</path>
16+
</source>
17+
</api>
18+
</version>
19+
</phpdocumentor>

0 commit comments

Comments
 (0)