Created PHP Docblock Checker (markdown)
parent
8aeded5ca3
commit
e26d8a9bca
16
PHP-Docblock-Checker.md
Normal file
16
PHP-Docblock-Checker.md
Normal file
|
@ -0,0 +1,16 @@
|
|||
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:
|
||||
|
||||
```yml
|
||||
php_docblock_checker:
|
||||
allowed_warnings: 10
|
||||
skip_classes: true
|
||||
```
|
Loading…
Reference in a new issue