Download the PHP package patgod85/phpdoc2rst without Composer
On this page you can find all versions of the php package patgod85/phpdoc2rst. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download patgod85/phpdoc2rst
More information about patgod85/phpdoc2rst
Files in patgod85/phpdoc2rst
Package phpdoc2rst
Short Description PHPDoc to RST
License MIT
Homepage https://github.com/patgod85/phpdoc2rst
Informations about the package phpdoc2rst
Phpdoc2rst
The tool for building of documentation for shared API in reStructuredText format
For main API entities
we can generate rst-files with data stored in PhpDoc annotations. Examples of results can be found here .
Installation:
The tool implemented as a bundle for Symfony 2 and provides 2 commands:
The command generates rst-files for specified target (Controllers, Models of Exceptions)
arguments:
- namespace - The namespace to process;
- path - The path the namespace can be found in;
options:
- --output, -o - The path to output the ReST files;
- --title, -t - An alternate title for the top level namespace;
- --exclude, -x - Semicolon separated namespaces to ignore;
- --target - Which elements need to select. Default value 'properties';
- --groups - Allows to fetch only properties of required group. A string divided by commas. Default value '';
- --header - Set the weight of main header for target==properties. Available options "h1" and "h2". Default value is "h1"
The command is a runner of several phpdoc2rst:process that specified in config.yml of the project
Example of config.yml section
For "properties" mode the annotation should be counted
To update the bundle:
- Commit the changes
- Add a tag with version number
- Push
- Run in the customer project
All versions of phpdoc2rst with dependencies
andrewsville/php-token-reflection Version dev-master
doctrine/annotations Version 1.2.*
doctrine/inflector Version 1.1.*
jms/serializer Version 1.4.*
symfony/config Version 3.4.*
symfony/console Version 3.4.*
symfony/framework-bundle Version 3.4.*
symfony/http-kernel Version 3.4.*
symfony/dependency-injection Version 3.4.*
symfony/process Version 3.4.*
twig/twig Version 1.*.*