deblan/php-censor
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Improved docs

Browse source
This commit is contained in:
Dmitry Khomutov 2016-07-19 15:12:28 +06:00
commit 320a249153
49 changed files with 454 additions and 193 deletions
Download patch file Download diff file Expand all files Collapse all files

10
docs/en/plugins/php_docblock_checker.md
View file

@ -1,13 +1,19 @@
Plugin PHP Docblock Checker
---------------------------
Runs the PHP Docblock Checker against your build. This tool verifies that all classes and methods have docblocks.
### Configuration Options:
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:
### Examples
```yml
php_docblock_checker: