Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Fetching contributors…
Cannot retrieve contributors at this time
83 lines (61 sloc) 3.99 KB
<?xml version="1.0" encoding="utf-8" ?>
<!-- This is a skeleton phpDox config file - Check for latest version and more info -->
<phpdox xmlns="" silent="false">
<!-- @silent: true | false to enable or disable visual output of progress -->
<!-- Additional bootstrap files to load for additional parsers and/or engines -->
<!-- Place as many require nodes as you feel like in this container -->
<!-- syntax: <require file="/path/to/file.php" /> -->
<bootstrap />
<!-- A phpDox project to process, you can have multiple projects in one config file -->
<project name="Serquant" source="library" workdir="build/api/xml">
<!-- @name - The name of the project -->
<!-- @source - The source directory of the application to process -->
<!-- @workdir - The directory to store the xml data files in -->
<!-- A phpDox config file can define additional variables (properties) per project -->
<!-- <property name="" value="the.value" /> -->
<!-- Values can make use of previously defined properties -->
<!-- The following are defined by default:
${basedir} Directory of the loaded config file is in
${phpDox.home} Directory of the phpDox installation
${phpDox.file} The current config file
${phpDox.version} phpDox' Version number
${} The value of project/@name if set, otherwise 'unnamed'
${phpDox.project.source} The value of project/@source if set, otherwise '${basedir}/src'
${phpDox.project.workdir} The value of project/@workdir if set, otherwise '${basedir}/xml'
${phpDox.php.version} The PHP Version of the interpreter in use
<!-- Additional configuration for the collecting process (parse of php code, generation of xml data) -->
<collector publiconly="false">
<!-- @publiconly - Flag to disable/enable processing of non public methods and members -->
<!-- <include / exclude filter for filelist generator -->
<include mask="*.php" />
<exclude mask="" />
<!-- Configuration of generation process -->
<generator output="build/api/doc">
<!-- @output - (Base-)Directory to store output data in -->
<!-- A generation process consists of one or more build tasks -->
<!-- <build engine="..." enabled="true" output="..." /> -->
<!-- @engine - The name of the engine this build task uses, use ./phpDox - -engines to get a list of available engines -->
<!-- @enabled - Flag to enable/disable this engine, default: enabled=true -->
<!-- @output - (optional) Output directory; if relative (no / as first char) it is interpreted as relative to generator/@output -->
<!-- An engine and thus build node can have additional configuration child nodes,
please check the documentation for the engine to find out more -->
<!-- default engine "html" -->
<build engine="html" enabled="true" output="html">
<!-- template dir="${phpDox.home}/templates/html" / -->
<build engine="todo" enabled="true" output="todo">
<file name="todolist.txt" encoding="utf-8" />
<build engine="graph" enabled="true" output="graph">
<dot executable="/opt/local/bin/dot" render="true" format="png" />
<build engine="xslrunner" enabled="true" output="html2">
<template dir="${phpDox.home}/templates/xslrunner" />
Jump to Line
Something went wrong with that request. Please try again.