Merge pull request #1258 from virtualtam/refactor/phpdoc

Replace Doxygen with phpDocumentor to generate reference documentation

.gitignore

@@ -22,15 +22,16 @@ inc/languages/*/LC_MESSAGES/shaarli.mo
 
 # Development and test resources
 coverage
-doxygen
 sandbox
 phpmd.html
+phpdoc.xml
 
 # User plugin configuration
 plugins/*/config.php
 
 # HTML documentation
 doc/html/
+doc/phpdoc/
 
 # 3rd party themes
 tpl/*

Makefile

@@ -146,10 +146,9 @@ authors:
 	@git shortlog -sne > AUTHORS
 	@rm .mailmap
 
-### generate Doxygen documentation
-doxygen: clean
-	@rm -rf doxygen
-	@doxygen Doxyfile
+### generate phpDocumentor documentation
+phpdoc: clean
+	@docker run --rm -v $(PWD):/data -u `id -u`:`id -g` phpdoc/phpdoc
 
 ### generate HTML documentation from Markdown pages with MkDocs
 htmldoc:

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>