2016-07-19 11:12:28 +02:00
|
|
|
Plugin PHP Docblock Checker
|
2017-01-04 13:22:20 +01:00
|
|
|
===========================
|
2016-07-19 11:12:28 +02:00
|
|
|
|
2016-07-17 16:20:35 +02:00
|
|
|
Runs the PHP Docblock Checker against your build. This tool verifies that all classes and methods have docblocks.
|
|
|
|
|
|
2016-07-19 11:12:28 +02:00
|
|
|
Configuration
|
2017-01-04 13:22:20 +01:00
|
|
|
-------------
|
2016-07-19 11:12:28 +02:00
|
|
|
|
|
|
|
|
### Options
|
2016-07-17 16:20:35 +02:00
|
|
|
|
|
|
|
|
* **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.
|
|
|
|
|
|
2016-07-19 11:12:28 +02:00
|
|
|
### Examples
|
2016-07-17 16:20:35 +02:00
|
|
|
|
|
|
|
|
```yml
|
|
|
|
|
php_docblock_checker:
|
|
|
|
|
allowed_warnings: 10
|
|
|
|
|
skip_classes: true
|
|
|
|
|
```
|
