Browse Source

doc: add phpDocumentor configuration

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

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
VirtualTam 6 months ago
parent
commit
1c53591a43
2 changed files with 23 additions and 0 deletions
  1. 2 0
      .gitignore
  2. 21 0
      phpdoc.dist.xml

+ 2 - 0
.gitignore

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

+ 21 - 0
phpdoc.dist.xml

@@ -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>