Merge remote-tracking branch 'origin/master'
[phpmyadmin.git] / phpdox.xml
blob1071dfe9e02b99f6e9f254a02a81e8c607e4ea21
1 <?xml version="1.0" encoding="utf-8" ?>
2 <!--  This is a skeleton phpDox config file - Check http://phpDox.de for latest version and more info -->
3 <phpdox xmlns="http://xml.phpdox.net/config" silent="false">
4     <!--  @silent: true | false to enable or disable visual output of progress -->
6     <!-- Additional bootstrap files to load for additional parsers and/or engines -->
7     <!-- Place as many require nodes as you feel like in this container -->
8     <!-- syntax: <require file="/path/to/file.php" /> -->
9     <bootstrap />
11     <!-- A phpDox project to process, you can have multiple projects in one config file -->
12     <project name="phpmyadmin" source="${basedir}/libraries" workdir="${basedir}/build/phpdox/xml">
13         <!--  @name    - The name of the project -->
14         <!--  @source  - The source directory of the application to process -->
15         <!--  @workdir - The directory to store the xml data files in -->
17         <!--  A phpDox config file can define additional variables (properties) per project -->
18         <!--  <property name="some.name" value="the.value" /> -->
20         <!--  Values can make use of previously defined properties -->
21         <!--  The following are defined by default:
23                 ${basedir}                Directory the loaded config file is in
25                 ${phpDox.home}            Directory of the phpDox installation
26                 ${phpDox.file}            The current config file
27                 ${phpDox.version}         phpDox' version number
29                 ${phpDox.project.name}    The value of project/@name if set, otherwise 'unnamed'
30                 ${phpDox.project.source}  The value of project/@source if set, otherwise '${basedir}/src'
31                 ${phpDox.project.workdir} The value of project/@workdir if set, otherwise '${basedir}/build/phpdox/xml'
33                 ${phpDox.php.version}     The PHP Version of the interpreter in use
35          -->
37         <!--  Additional configuration for the collecting process (parse of php code, generation of xml data) -->
38         <collector publiconly="false" backend="parser">
39             <!--  @publiconly - Flag to disable/enable processing of non public methods and members -->
40             <!--  @backend    - The collector backend to use, currently only shipping with 'parser' -->
42             <!--  <include / exclude filter for filelist generator, mask must follow fnmatch() requirements  -->
43             <include mask="*.php" />
44             <exclude mask="" />
46             <!--  How to handle inheritance -->
47             <inheritance resolve="true">
48                 <!--  @resolve - Flag to enable/disable resolving of inheritance -->
50                 <!--  You can define multiple (external) dependencies to be included -->
51                 <!--  <dependency  path="" -->
52                 <!--    @path  - path to a directory containing an index.xml for a dependency project -->
53             </inheritance>
55         </collector>
57         <!--  Configuration of generation process -->
58         <generator output="${basedir}/build/phpdox">
59             <!-- @output - (Base-)Directory to store output data in -->
61             <!-- A generation process consists of one or more build tasks and of (optional) enrich sources -->
63             <enrich base="${basedir}/build">
64                 <!-- @base - (Base-)Directory of datafiles used for enrich process -->
66                 <!-- add build information - this should always be enabled -->
67                 <source type="build" />
69                 <!-- add phploc output -->
70                 <source type="phploc" />
72                 <!-- add git vcs information -->
73                 <source type="git">
74                     <git binary="/usr/bin/git" />
75                     <history enabled="true" limit="15" cache="${phpDox.project.workdir}/gitlog.xml" />
76                 </source>
79                 <!-- enrichment source -->
80                 <!--<source type="checkstyle">-->
81                     <!-- @type - the handler for the enrichment -->
82                     <!--         known types by default are: checkstyle, pmd, clover, phpunit -->
84                     <!-- every enrichment source can have additional configuration nodes, most probably need a logfile -->
85                     <!-- <file name="logs/checkstyle.xml" /> -->
86                 <!--</source> -->
88                 <!-- enrichment source -->
89                 <!--<source type="phpcs">-->
90                 <!-- @type - the handler for the enrichment -->
91                 <!--         known types by default are: checkstyle, pmd, clover, phpunit, phpcs -->
93                 <!-- every enrichment source can have additional configuration nodes, most probably need a logfile -->
94                 <!-- <file name="logs/phpcs.xml" /> -->
95                 <!--</source> -->
97                 <!-- PHPMessDetector -->
98                 <!--
99                 <source type="pmd">
100                     <file name="pmd.xml" />
101                 </source>
102                 -->
104             </enrich>
106             <!-- <build engine="..." enabled="true" output="..." /> -->
107             <!--   @engine  - The name of the engine this build task uses, use ./phpDox - -engines to get a list of available engines -->
108             <!--   @enabled - Flag to enable/disable this engine, default: enabled=true -->
109             <!--   @output  - (optional) Output directory; if relative (no / as first char) it is interpreted as relative to generator/@output -->
111             <!-- An engine and thus build node can have additional configuration child nodes, please check the documentation for the engine to find out more -->
113             <!--  default engine "html" -->
114             <build engine="html" enabled="true" output="html">
115                 <template dir="${phpDox.home}/templates/html" />
116                 <file extension="html" />
117             </build>
119         </generator>
120     </project>
122 </phpdox>