Skip to content

Commit 2fef6be

Browse files
committed
Updated dependencies + improved docs.
1 parent 23a9b06 commit 2fef6be

7 files changed

+29
-9
lines changed

README.md

+4
Original file line numberDiff line numberDiff line change
@@ -43,3 +43,7 @@ none | --ansi | Force ANSI output.
4343
none | --no-ansi | Disable ANSI output.
4444
-n | --no-interaction | Do not ask any interactive question.
4545
-v -vv -vvv | --verbose | Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug.
46+
47+
## License
48+
49+
PHPDoc Checker is open source software licensed under the [BSD-2-Clause license](LICENSE).

bin/phpdoc-checker

+3-4
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,10 @@
22
<?php declare(strict_types = 1);
33

44
/**
5-
* PHP Docblock Checker
5+
* @package PHPDoc Checker
66
*
7-
* @copyright Copyright 2014, Block 8 Limited.
8-
* @license https://github.com/Block8/php-docblock-checker/blob/master/LICENSE.md
9-
* @link http://www.phptesting.org/
7+
* @author Dmitry Khomutov <[email protected]>
8+
* @author Dan Cryer <[email protected]>
109
*/
1110

1211
$ownVendorAutoloader = \dirname(__DIR__) . '/vendor/autoload.php';

composer.lock

+5-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/CheckerApplication.php

+5
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,11 @@
1010

1111
/**
1212
* Extension of Symfony's console application class to allow us to have a single, default command.
13+
*
14+
* @package PHPDoc Checker
15+
*
16+
* @author Dmitry Khomutov <[email protected]>
17+
* @author Dan Cryer <[email protected]>
1318
*/
1419
class CheckerApplication extends Application
1520
{

src/CheckerCommand.php

+3
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@
1313
/**
1414
* Console command to check a directory of PHP files for Docblocks.
1515
*
16+
* @package PHPDoc Checker
17+
*
18+
* @author Dmitry Khomutov <[email protected]>
1619
* @author Dan Cryer <[email protected]>
1720
*/
1821
class CheckerCommand extends Command

src/DocBlockParser.php

+4-2
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,11 @@
77
/**
88
* Parse the docblock of a function or method
99
*
10-
* @author Paul Scott <[email protected]>
10+
* @package PHPDoc Checker
1111
*
12-
* {@link http://www.github.com/icio/PHP-DocBlock-Parser}
12+
* @author Dmitry Khomutov <[email protected]>
13+
* @author Dan Cryer <[email protected]>
14+
* @author Paul Scott <[email protected]> (http://www.github.com/icio/PHP-DocBlock-Parser)
1315
*/
1416
class DocBlockParser
1517
{

src/FileProcessor.php

+5
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,11 @@
1515

1616
/**
1717
* Uses Nikic/PhpParser to parse PHP files and find relevant information for the checker.
18+
*
19+
* @package PHPDoc Checker
20+
*
21+
* @author Dmitry Khomutov <[email protected]>
22+
* @author Dan Cryer <[email protected]>
1823
*/
1924
class FileProcessor
2025
{

0 commit comments

Comments
 (0)