Linux command
phpdox 命令
文本
复制后可按需替换文件名、目录或参数。
常用示例
Generate documentation using the default config
phpdox
Use a specific configuration file
phpdox -f [phpdox.xml]
Run only the collector phase
phpdox -c
Run only the generator phase
phpdox -g
Generate a skeleton configuration file
phpdox --skel > [phpdox.xml]
Generate a skeleton config without comments
phpdox --skel --strip > [phpdox.xml]
List available output engines
phpdox --engines
说明
phpDox generates PHP API documentation from source code using standard technologies (SRC, DOCBLOCK, XML and XSLT). It parses PHP source files, extracts PHPDoc comment blocks, and produces HTML documentation. Configuration is defined in an XML file (typically phpdox.xml). The documentation process has two phases: the collector parses source code into an XML representation, and the generator transforms it into output using configurable engines and enrichers.
参数
- -f, --file _FILE_
- Use specified XML configuration file (defaults to ./phpdox.xml or ./phpdox.xml.dist).
- -c, --collector
- Run only the collector process (source parsing).
- -g, --generator
- Run only the generator process (documentation output).
- --backends
- Show a list of available backends and exit.
- --engines
- Show a list of available output engines and exit.
- --enrichers
- Show a list of available output enrichers and exit.
- --skel
- Show an annotated skeleton configuration XML file and exit.
- --strip
- Strip comments from skeleton config XML when using --skel.
- -v, --version
- Display application version.
- -h, --help
- Display help information.
FAQ
What is the phpdox command used for?
phpDox generates PHP API documentation from source code using standard technologies (SRC, DOCBLOCK, XML and XSLT). It parses PHP source files, extracts PHPDoc comment blocks, and produces HTML documentation. Configuration is defined in an XML file (typically phpdox.xml). The documentation process has two phases: the collector parses source code into an XML representation, and the generator transforms it into output using configurable engines and enrichers.
How do I run a basic phpdox example?
Run `phpdox` in a terminal, then adjust file names, paths, flags, or remote targets for your system.
What does -f, --file _FILE_ do in phpdox?
Use specified XML configuration file (defaults to ./phpdox.xml or ./phpdox.xml.dist).