1 PHP Docblock Checker

Dan Cryer edited this page 2014-05-09 03:33:29 -07:00

Table of Contents

• Configuration Options:
• Example config:

Runs the PHP Docblock Checker against your build. This tool verifies that all classes and methods have docblocks.

Configuration Options:

• allowed_warnings - Optional - The warning limit for a successful build.
• path - Optional - Directory in which PHP Docblock Checker should run.
• skip_methods - Optional - Tells the checker to ignore methods that don't have a docblock.
• skip_classes - Optional - Tells the checker to ignore classes that don't have a docblock.

Example config:

php_docblock_checker:
    allowed_warnings: 10
    skip_classes: true