phpdox.xml 5.9KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125
  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 -->
  5. <!-- Additional bootstrap files to load for additional parsers, enrichers and/or engines -->
  6. <!-- Place as many require nodes as you feel like in this container -->
  7. <!-- syntax: <require file="/path/to/file.php" /> -->
  8. <bootstrap />
  9. <!-- A phpDox project to process, you can have multiple projects in one config file -->
  10. <project name="Query" source="src" workdir="build/phpdox/xml">
  11. <!-- @name - The name of the project -->
  12. <!-- @source - The source directory of the application to process -->
  13. <!-- @workdir - The directory to store the xml data files in -->
  14. <!-- A phpDox config file can define additional variables (properties) per project -->
  15. <!-- <property name="some.name" value="the.value" /> -->
  16. <!-- Values can make use of previously defined properties -->
  17. <!-- The following are defined by default:
  18. ${basedir} Directory the loaded config file is in
  19. ${phpDox.home} Directory of the phpDox installation
  20. ${phpDox.file} The current config file
  21. ${phpDox.version} phpDox' version number
  22. ${phpDox.project.name} The value of project/@name if set, otherwise 'unnamed'
  23. ${phpDox.project.source} The value of project/@source if set, otherwise '${basedir}/src'
  24. ${phpDox.project.workdir} The value of project/@workdir if set, otherwise '${basedir}/build/phpdox/xml'
  25. ${phpDox.php.version} The PHP Version of the interpreter in use
  26. -->
  27. <!-- Additional configuration for the collecting process (parsing of php code, generation of xml data) -->
  28. <collector publiconly="true" backend="parser" encoding="auto">
  29. <!-- @publiconly - Flag to disable/enable processing of non public methods and members -->
  30. <!-- @backend - The collector backend to use, currently only shipping with 'parser' -->
  31. <!-- @encoding - Charset encoding of source files (overwrite default 'auto' if detection fails) -->
  32. <!-- <include / exclude filter for filelist generator, mask must follow fnmatch() requirements -->
  33. <include mask="*.php" />
  34. <exclude mask="" />
  35. <!-- How to handle inheritance -->
  36. <inheritance resolve="true">
  37. <!-- @resolve - Flag to enable/disable resolving of inheritance -->
  38. <!-- You can define multiple (external) dependencies to be included -->
  39. <!-- <dependency path="" -->
  40. <!-- @path - path to a directory containing an index.xml for a dependency project -->
  41. </inheritance>
  42. </collector>
  43. <!-- Configuration of generation process -->
  44. <generator output="apiDocumentation">
  45. <!-- @output - (Base-)Directory to store output data in -->
  46. <!-- A generation process consists of one or more build tasks and of (optional) enrich sources -->
  47. <enrich base="build/logs">
  48. <!-- @base - (Base-)Directory of datafiles used for enrich process -->
  49. <!--<source type="...">-->
  50. <!-- @type - the handler for the enrichment -->
  51. <!-- known types by default are: build, checkstyle, git, phpcs, phploc, phpunit, pmd -->
  52. <!-- every enrichment source can have additional configuration nodes, most probably need a logfile -->
  53. <!-- <file name="path/to/log.xml" /> -->
  54. <!--</source> -->
  55. <!-- add phploc output -->
  56. <source type="phploc">
  57. <file name="phploc.xml" />
  58. </source>
  59. <!-- git vcs information -->
  60. <source type="git">
  61. <git binary="/usr/bin/git" />
  62. <history enabled="true" limit="15" cache="${phpDox.project.workdir}/gitlog.xml" />
  63. </source>
  64. <!-- PHP Code Sniffer findings -->
  65. <source type="phpcs">
  66. <file name="phpcs.xml" />
  67. </source>
  68. <!-- PHPMessDetector -->
  69. <!--
  70. <source type="pmd">
  71. <file name="pmd.xml" />
  72. </source>
  73. -->
  74. <!-- PHPUnit Coverage XML -->
  75. <source type="phpunit">
  76. <coverage path="coverage" />
  77. <!-- <coverage path="clover.xml" />-->
  78. <!-- @path - the directory where the xml code coverage report can be found -->
  79. <!--<filter directory="${phpDox.project.source}" />-->
  80. <!-- @directory - path of the phpunit config whitelist filter directory -->
  81. </source>
  82. </enrich>
  83. <!-- <build engine="..." enabled="true" output="..." /> -->
  84. <!-- @engine - The name of the engine this build task uses, use ./phpDox - -engines to get a list of available engines -->
  85. <!-- @enabled - Flag to enable/disable this engine, default: enabled=true -->
  86. <!-- @output - (optional) Output directory; if relative (no / as first char) it is interpreted as relative to generator/@output -->
  87. <!-- An engine and thus build node can have additional configuration child nodes, please check the documentation for the engine to find out more -->
  88. <!-- default engine "html" -->
  89. <build engine="html" enabled="true">
  90. <template dir="${phpDox.home}/templates/html" />
  91. <file extension="html" />
  92. </build>
  93. </generator>
  94. </project>
  95. </phpdox>