{"id":26480163,"url":"https://github.com/php-censor/phpdoc-checker","last_synced_at":"2025-07-12T04:33:58.300Z","repository":{"id":32665644,"uuid":"137566813","full_name":"php-censor/phpdoc-checker","owner":"php-censor","description":"A simple tool for checking that your PHP classes and methods use PHPDocs (PHP DocBlock Checker fork).  ","archived":false,"fork":false,"pushed_at":"2023-10-07T14:42:48.000Z","size":209,"stargazers_count":13,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-05-25T21:48:54.165Z","etag":null,"topics":["hacktoberfest"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/php-censor.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-06-16T08:48:06.000Z","updated_at":"2024-10-22T09:30:15.000Z","dependencies_parsed_at":"2024-06-21T05:58:17.385Z","dependency_job_id":null,"html_url":"https://github.com/php-censor/phpdoc-checker","commit_stats":null,"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"purl":"pkg:github/php-censor/phpdoc-checker","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/php-censor%2Fphpdoc-checker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/php-censor%2Fphpdoc-checker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/php-censor%2Fphpdoc-checker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/php-censor%2Fphpdoc-checker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/php-censor","download_url":"https://codeload.github.com/php-censor/phpdoc-checker/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/php-censor%2Fphpdoc-checker/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261989908,"owners_count":23241171,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacktoberfest"],"created_at":"2025-03-20T02:06:14.260Z","updated_at":"2025-07-12T04:33:58.270Z","avatar_url":"https://github.com/php-censor.png","language":"PHP","readme":"[![Minimum PHP version: 7.4.0](https://img.shields.io/badge/php-7.4.0%2B-blue.svg?label=PHP)](https://packagist.org/packages/php-censor/phpdoc-checker)\n[![Actions](https://github.com/php-censor/phpdoc-checker/actions/workflows/ci.yaml/badge.svg)](https://github.com/php-censor/phpdoc-checker/actions)\n[![PHP Censor](http://ci.php-censor.info/build-status/image/16?branch=master\u0026label=PHP%20Censor)](http://ci.php-censor.info/build-status/view/16?branch=master)\n[![Codecov](https://codecov.io/gh/php-censor/phpdoc-checker/branch/master/graph/badge.svg)](https://codecov.io/gh/php-censor/phpdoc-checker)\n[![Latest Version](https://img.shields.io/packagist/v/php-censor/phpdoc-checker.svg?label=Version)](https://packagist.org/packages/php-censor/phpdoc-checker)\n[![Total downloads](https://img.shields.io/packagist/dt/php-censor/phpdoc-checker.svg?label=Downloads)](https://packagist.org/packages/php-censor/phpdoc-checker)\n[![License](https://img.shields.io/packagist/l/php-censor/phpdoc-checker.svg?label=License)](https://packagist.org/packages/php-censor/phpdoc-checker)\n\n# PHPDoc Checker\n\nCheck PHP files within a directory for appropriate use of PHPDocs (Docblocks). PHPDoc Checker is fork of \n[PHP DocBlock Checker](https://github.com/Block8/php-docblock-checker). \n\n## Installation\n**Composer**:\u003cbr\u003e\n\n```bash\ncomposer require php-censor/phpdoc-checker\n```\n\n## Building Phar Package\n\n```bash\nbox.phar compile\n```\n\n## Usage\n\n```bash\nvendor/bin/phpdoc-checker {params}\n```\n\n### Parameters\n\nShort | Long | Description\n------------ | ------------- | -----------\n-h | --help | Display help message.\n-x | --exclude=EXCLUDE | Files and directories to exclude.\n-d | --directory=DIRECTORY | Directory to scan. [default: \"./\"]\n-f | --files=FILES | Files to scan.\nnone | --skip-classes | Don't check classes for docblocks.\nnone | --skip-methods | Don't check methods for docblocks.\nnone | --skip-signatures | Don't check docblocks against method signatures.\n-j | --json | Output JSON instead of a log.\n-l | --files-per-line=FILES-PER-LINE | Number of files per line in progress [default: 50]\n-w | --fail-on-warnings | Consider the check failed if any warnings are produced.\n-i | --info-only | Information-only mode, just show summary.\n-q | --quiet | Do not output any message.\n-V | --version | Display this application version.\nnone | --ansi | Force ANSI output.\nnone | --no-ansi | Disable ANSI output.\n-n | --no-interaction | Do not ask any interactive question.\n-v -vv -vvv | --verbose | Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug.\n\n## Unit tests\n\nPhpunit tests:\n\n```bash\nvendor/bin/phpunit --configuration=phpunit.xml.dist --coverage-text --coverage-html=tests/var/coverage\n```\n\n## License\n\nPHPDoc Checker is open source software licensed under the [BSD-2-Clause license](LICENSE).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphp-censor%2Fphpdoc-checker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fphp-censor%2Fphpdoc-checker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphp-censor%2Fphpdoc-checker/lists"}