Skip to content

Commit cb4214b

Browse files
committed
Added README file.
1 parent 1ddc6a4 commit cb4214b

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
##PHP DocBlock Checker
2+
3+
A basic CLI (Command Line Interface) tool to verify if your PHP classes have DocBlocks.
4+
5+
###What it does?
6+
7+
This tool can:
8+
9+
- Check if every PHP class and it's methods does have their own DocBlock.
10+
11+
###What it does not?
12+
- It doesn't check for the integrity of your DocBlocks **at this time**.
13+
14+
###What does it requires?
15+
Please check `composer.json` for details.
16+
17+
###Where is the documentation?
18+
Please check `docs.md` for further information on how to use this tool.
19+
20+
###And, in case I want some references?
21+
22+
- [phpDocumentor list of DocBlock tags](http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.pkg.html)
23+
- [Project source](https://github.com/Block8/php-docblock-checker)
24+
- [PSR-5 PHPDoc Standard [**DRAFT**]](https://github.com/php-fig/fig-standards/pull/169/files)

0 commit comments

Comments
 (0)