Knah-Tsaeb/MyShaarli
Knah-Tsaeb/MyShaarli
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

doc: add phpDocumentor configuration

Browse source 
See:
- https://phpdoc.org/
- https://docs.phpdoc.org/references/configuration.html
- https://github.com/phpDocumentor/phpDocumentor2

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
This commit is contained in:
VirtualTam 2019-01-18 22:24:58 +01:00
parent ff3b5dc554
commit 1c53591a43
2 changed files with 23 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.gitignore vendored
View file

@ -25,12 +25,14 @@ coverage
doxygen doxygen
sandbox sandbox
phpmd.html phpmd.html
phpdoc.xml
# User plugin configuration # User plugin configuration
plugins/*/config.php plugins/*/config.php
# HTML documentation # HTML documentation
doc/html/ doc/html/
doc/phpdoc/
# 3rd party themes # 3rd party themes
tpl/* tpl/*

21
phpdoc.dist.xml Normal file
View file

@ -0,0 +1,21 @@
<?xml version="1.0" encoding="UTF-8" ?>
<phpdoc>
<title><![CDATA[Shaarli API Reference]]></title>
<parser>
<encoding>utf8</encoding>
<markers>
<item>FIXME</item>
<item>TODO</item>
<item>WIP</item>
</markers>
<target>doc/phpdoc</target>
</parser>
<transformer>
<target>doc/phpdoc</target>
</transformer>
<files>
<file>index.php</file>
<directory>application</directory>
<directory>plugins</directory>
</files>
</phpdoc>