Download the PHP package soundasleep/phpdoc2 without Composer
On this page you can find all versions of the php package soundasleep/phpdoc2. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download soundasleep/phpdoc2
More information about soundasleep/phpdoc2
Files in soundasleep/phpdoc2
Package phpdoc2
Short Description Parse PHP documentation blocks and generate HTML output
License
Informations about the package phpdoc2
soundasleep/phpdoc2
soundasleep/phpdoc2
is another PHP documentation generator, but tries to be cleaner
and smarter and more extensible than existing solutions.
For example, mark up your classes and methods with PHPDoc comment blocks:
Using
For easy documentation generation, you can use Grunt with the grunt-phpdoc2 task. For example, see the example Gruntfile provided in the phpdoc2-openclerk.
Templates
To override or extend these templates, add --templates "dir"
. The generator will add this directory of templates to override the default ones. Uses openclerk/pages, which means you can call subtemplates.
Demos
Top-level tags supported
@throws
(Class) (description)@param
$name (description)@return
description@see
(Class) (description)@deprecated
(description)
Inline tags supported
{@link http://foo.com}
{@link Class}
,{@link #method},
{@link Class#method},
{@link Class description},
{@link Plural}s` etc{@code ...}
TODO
- Look at compatibility with phpdoc PSR standard and reference PSR examples
- Method and class summaries should only display the first sentance of the 'title' doc
- Highlight abstract classes
- Display inherited abstract methods on abstract classes
@author
tag@since
tag@var
tag@inheritDoc
inline tag - might be tricky- Class variables
- Class constants
- Global functions support
- Global constants
- Option for
issue #123
to link to an external issue tracker - Link through to open source projects for composer projects
- Link through to source code for GitHub projects
See also
All versions of phpdoc2 with dependencies
monolog/monolog Version ~1.13
corneltek/getoptionkit Version ~2.0
openclerk/pages Version ^0.2.1