Fork PHP Docblock Checker to PHPDoc Checker.

Author: corpsee

.gitignore

@@ -1,4 +1,2 @@
-.DS_Store
-.idea
 vendor
-phpdoccheck.phar
+phpdoc-checker.phar

LICENSE.md renamed to LICENSE

@@ -1,3 +1,6 @@
+Copyright (c) 2018, PHP Censor
+All rights reserved.
+
 Copyright (c) 2014, Block 8 Limited
 All rights reserved.
 
@@ -6,4 +9,4 @@ Redistribution and use in source and binary forms, with or without modification,
 - Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
 - Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
 
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -1,17 +1,21 @@
-# PHP DocBlock Checker
-Check PHP files within a directory for appropriate use of Docblocks.
+# PHPDoc Checker
+
+Check PHP files within a directory for appropriate use of PHPDocs (Docblocks). PHPDoc Checker is fork of 
+[PHP DocBlock Checker](https://github.com/Block8/php-docblock-checker). 
 
 ## Installation
 **Composer**:<br>
-<code>
-composer require block8/php-docblock-checker
-</code>
+
+```bash
+composer require php-censor/phpdoc-checker
+```
 
 ## Usage
 **CMD**:<br>
-<code>
-call vendor/bin/phpdoccheck {params}
-</code>
+
+```bash
+vendor/bin/phpdoccheck {params}
+```
 
 ## Parameters
 
@@ -32,4 +36,5 @@ none | --skip-signatures | Don't check docblocks against method signatures.
 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.
+-v -vv -vvv | --verbose | Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 
+for debug.

bin/phpdoc-checker

@@ -0,0 +1,25 @@
+#!/usr/bin/env php
+
+<?php
+/**
+ * PHP Docblock Checker
+ *
+ * @copyright    Copyright 2014, Block 8 Limited.
+ * @license      https://github.com/Block8/php-docblock-checker/blob/master/LICENSE.md
+ * @link         http://www.phptesting.org/
+ */
+
+$ownVendorAutoloader    = dirname(__DIR__) . '/vendor/autoload.php';
+$parentVendorAutoloader = dirname(__DIR__) . '/../../autoload.php';
+
+if (file_exists($ownVendorAutoloader)) {
+    require_once($ownVendorAutoloader);
+} elseif (file_exists($parentVendorAutoloader)) {
+    require_once($parentVendorAutoloader);
+}
+
+$command = new PhpDocChecker\CheckerCommand();
+
+$application = new PhpDocChecker\CheckerApplication('PHP Docblock Checker', '@package_version@');
+$application->add($command);
+$application->run();

box.json

@@ -4,7 +4,7 @@
         "."
     ],
     "files": [
-        "LICENSE.md"
+        "LICENSE"
     ],
     "finder": [
         {
@@ -13,8 +13,9 @@
             "in": "vendor"
         }
     ],
+    "compression": "GZ",
     "git-version": "package_version",
-    "main": "phpdoccheck",
-    "output": "phpdoccheck.phar",
-    "stub": true
-}
+    "main":        "bin/phpdoc-checker",
+    "output":      "phpdoc-checker.phar",
+    "stub":        true
+}

composer.json

@@ -1,39 +1,40 @@
 {
-    "name"             : "block8/php-docblock-checker",
-    "description"      : "A simple tool for checking that your PHP classes and methods use docblocks.",
+    "name"             : "php-censor/phpdoc-checker",
+    "description"      : "A simple tool for checking that your PHP classes and methods use PHPDocs (PHP DocBlocks Checker fork).",
     "minimum-stability": "stable",
     "type"             : "library",
-    "keywords"         : ["php", "phpci", "testing", "docblock", "comment", "checker", "code quality"],
-    "homepage"         : "https://www.phptesting.org/",
+    "keywords"         : ["php", "php-censor", "testing", "docblock", "phpdoc", "comment", "checker", "code quality"],
+    "homepage"         : "https://github.com/php-censor/phpdoc-checker",
     "license"          : "BSD-2-Clause",
-
-    "authors": [
+    "authors":  [
         {
-            "name"    : "Dan Cryer",
-            "email"   : "dan.cryer@block8.co.uk",
+            "name":     "Dmitry Khomutov",
+            "email":    "poisoncorpsee@gmail.com",
+            "homepage": "http://corpsee.com",
+            "role":     "PHPDoc Checker"
+        },
+        {
+            "name":     "Dan Cryer",
+            "email":    "dan.cryer@block8.co.uk",
             "homepage": "http://www.block8.co.uk",
-            "role"    : "Developer"
+            "role":     "PHP DocBlocks Checker developer"
         }
     ],
-
     "support": {
-        "issues": "https://github.com/Block8/php-docblock-checker/issues",
-        "source": "https://github.com/Block8/php-docblock-checker"
+        "issues": "https://github.com/php-censor/phpdoc-checker/issues",
+        "source": "https://github.com/php-censor/phpdoc-checker"
+    },
+    "autoload": {
+        "psr-4": {
+            "PhpDocChecker\\": "src/"
+        }
     },
-
     "require": {
-        "php": ">=5.3.3",
+        "php":              ">=5.6.0",
         "nikic/php-parser": "3.*",
-        "symfony/console": "3.*"
-    },
-
-    "require-dev": {
-        "phpmd/phpmd": "~2.0",
-        "squizlabs/php_codesniffer": "~1.5",
-        "phploc/phploc": "~2.0"
+        "symfony/console":  "~3.4.0"
     },
-
     "bin": [
-        "phpdoccheck"
+        "bin/phpdoc-checker"
     ]
 }