2017 © Pedro Peláez
 

library phpdoc-checker

A simple tool for checking that your PHP classes and methods use PHPDocs (PHP DocBlocks Checker fork).

image

php-censor/phpdoc-checker

A simple tool for checking that your PHP classes and methods use PHPDocs (PHP DocBlocks Checker fork).

  • PHP
  • 1 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 3 Versions
  • 0 % Grown

The README.md

Minimum PHP version: 7.4.0 Actions PHP Censor Codecov Latest Version Total downloads License, (*1)

PHPDoc Checker

Check PHP files within a directory for appropriate use of PHPDocs (Docblocks). PHPDoc Checker is fork of PHP DocBlock Checker., (*2)

Installation

Composer:
, (*3)

composer require php-censor/phpdoc-checker

Building Phar Package

box.phar compile

Usage

vendor/bin/phpdoc-checker {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: "./"]
-f --files=FILES Files to scan.
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.

Unit tests

Phpunit tests:, (*4)

vendor/bin/phpunit --configuration=phpunit.xml.dist --coverage-text --coverage-html=tests/var/coverage

License

PHPDoc Checker is open source software licensed under the BSD-2-Clause license., (*5)

The Versions

30/06 2018

dev-master

9999999-dev https://github.com/php-censor/phpdoc-checker

A simple tool for checking that your PHP classes and methods use PHPDocs (PHP DocBlocks Checker fork).

  Sources   Download

BSD-2-Clause

The Requires

 

by Dan Cryer
by Dmitry Khomutov

testing php phpdoc docblock checker comment code quality php-censor

30/06 2018

dev-release-1.0

dev-release-1.0 https://github.com/php-censor/phpdoc-checker

A simple tool for checking that your PHP classes and methods use PHPDocs (PHP DocBlocks Checker fork).

  Sources   Download

BSD-2-Clause

The Requires

 

by Dan Cryer
by Dmitry Khomutov

testing php phpdoc docblock checker comment code quality php-censor

30/06 2018

1.0.0

1.0.0.0 https://github.com/php-censor/phpdoc-checker

A simple tool for checking that your PHP classes and methods use PHPDocs (PHP DocBlocks Checker fork).

  Sources   Download

BSD-2-Clause

The Requires

 

by Dan Cryer
by Dmitry Khomutov

testing php phpdoc docblock checker comment code quality php-censor