divante-ltd/php-docblock-checker

A simple tool for checking that your PHP classes and methods use docblocks.

1.4.3 2018-03-23 12:35 UTC

Requires

• php: >=5.3.3
• nikic/php-parser: 3.*
• symfony/console: 3.*

Requires (Dev)

• phploc/phploc: ~2.0
• phpmd/phpmd: ~2.0
• squizlabs/php_codesniffer: ~1.5

BSD-2-Clause

• Dan Cryer

• php
• comment
• testing
• docblock
• phpci
• checker
• code quality

README

Check PHP files within a directory for appropriate use of Docblocks.

Installation

Composer:
composer require divante-ltd/php-docblock-checker

Usage

CMD:
call vendor/bin/phpdoccheck {params}

Parameters

Short	Long	Description
-h	--help	Display help message.
-x	--exclude=EXCLUDE	Files and directories to exclude.
-d	--directory=DIRECTORY	Directory to scan. [default: "./"]
none	--skip-classes	Don't check classes for docblocks.
none	--skip-methods	Don't check methods for docblocks.
none	--skip-signatures	Don't check docblocks against method signatures.
-j	--json	Output JSON instead of a log.
-l	--files-per-line=FILES-PER-LINE	Number of files per line in progress [default: 50]
-w	--fail-on-warnings	Consider the check failed if any warnings are produced.
-i	--info-only	Information-only mode, just show summary.
-q	--quiet	Do not output any message.
-V	--version	Display this application version.
none	--ansi	Force ANSI output.
none	--no-ansi	Disable ANSI output.
-n	--no-interaction	Do not ask any interactive question.
-v -vv -vvv	--verbose	Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug.