summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPhil Sturgeon <email@philsturgeon.co.uk>2012-05-02 12:37:31 +0200
committerPhil Sturgeon <email@philsturgeon.co.uk>2012-05-02 12:37:31 +0200
commit3110a0a3cc6b25985acc251799ca9cc97f92ce03 (patch)
tree93cc2260b457241401bcc604a82b829391b4dd67
parent963c96c5507ceb8b5c3de50d0ab959d21dcc8cd1 (diff)
Added a phpDocumenter config file
Allows API documentation to be built very easily. Wether or not CodeIgniter will support property docblocks or not is currently in question, but at least everything else will show up.
-rw-r--r--phpdoc.dist.xml25
1 files changed, 25 insertions, 0 deletions
diff --git a/phpdoc.dist.xml b/phpdoc.dist.xml
new file mode 100644
index 000000000..f1fcc6225
--- /dev/null
+++ b/phpdoc.dist.xml
@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<phpdoc>
+ <title>CodeIgniter v3.0.0 API</title>
+ <parser>
+ <target>./api/</target>
+ </parser>
+ <transformer>
+ <target>./api/</target>
+ </transformer>
+ <files>
+ <directory>.</directory>
+ <ignore>./application/*</ignore>
+ <ignore>./tests/*</ignore>
+ <ignore>./user_guide_src/*</ignore>
+ <ignore>./views/*</ignore>
+ </files>
+
+ <logging>
+ <level>warn</level>
+ <paths>
+ <default>./api/log/{DATE}.log</default>
+ <errors>./api/{DATE}.errors.log</errors>
+ </paths>
+ </logging>
+</phpdoc> \ No newline at end of file