Automatically generate PHPDoc comments for DataObject subclasses based on fields and relations.
Automatically generate PHPDoc comments for DataObject subclasses based on fields and relations. Existing PHPDoc comments and directives are preserved at the beginning of comments.
composer require --dev atkinshealth/silverstripe-autodoc 1.x-dev
You can use choosealicense.com to help pick a suitable license for your project.
As this module directly modifies your source .php files, it is recommended that you only run it on projects in source control, with a clean working copy. To run the docblock generation, visit
/dev/autodoc through sake
./vendor/bin/sake dev/autodoc module=app flush=1
If the module argument is left out, it will default to the
app module. This can be changed through yaml configuration
This module by default generates docblocks for the
app module, which is the default module for new SilverStripe projects. This default can be changed.
AtkinsHealth\AutoDoc\AutoDocController: default_module: mysite
Bugs are tracked in the issues section of this repository. Before submitting an issue please read over
existing issues to ensure yours is unique.
If the issue does look like a new bug:
Please report security issues to the module maintainers directly. Please don't file security issues in the bugtracker.
If you would like to make contributions to the module please ensure you raise a pull request and discuss with the module maintainers.
Module rating system helping users find modules that are well supported. For more on how the rating system works visit Module standards
Score not correct? Let us know there is a problem