|
phpDocumentor is sometimes referred to as phpdoc or phpdocu.
Similar to Javadoc and RDoc, it is written in PHP and can be used from the command line or a web interface to create professional documentation from PHP source code.
Here are some key features of "phpDocumentor":
· Output in HTML, PDF (directly), CHM (with windows help compiler), XML DocBook
· Very fast
· Web and command-line interface
· Fully customizable output with Smarty-based templates
· Recognizes JavaDoc-style documentation
· Automatic linking, class inheritance diagrams and intelligent override
· Customizable source code highlighting, with phpxref-style cross-referencing
· Parses standard README/CHANGELOG/INSTALL/FAQ files and includes them directly in documentation
· Generates a todo list from @todo tags in source
· Generates multiple documentation sets based on @access private, @internal and {@internal} tags
· Example PHP files can be placed directly in documentation with highlighting and phpxref linking using the @example tag
· Linking between external manual and API documentation is possible at the sub-section level in all output formats
· Easily extended for specific documentation needs with Converter
· Full documentation of every feature, manual can be generated directly from the source code with "phpdoc -c makedocs" in any format desired.
· User .ini files can be used to control output, multiple outputs can be generated at once.
Via: phpDocumentor 1.4.4 / 1.5.0a1 / v2.0.0a10
0 Comment:
Post a Comment