From: VirtualTam <virtualtam@flibidi.net>
Date: Fri, 18 Jan 2019 21:24:58 +0000 (+0100)
Subject: doc: add phpDocumentor configuration
X-Git-Tag: v0.11.0~40^2~2
X-Git-Url: https://git.immae.eu/?a=commitdiff_plain;h=1c53591a43cfea0c7c7ca0ed4cd223cef842eaf3;p=github%2Fshaarli%2FShaarli.git

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

diff --git a/.gitignore b/.gitignore
index 414ff6d5..ce2ebe28 100644
--- a/.gitignore
+++ b/.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/*
diff --git a/phpdoc.dist.xml b/phpdoc.dist.xml
new file mode 100644
index 00000000..3878550e
--- /dev/null
+++ b/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>