Don't require class doc block

chadicus · chadicus · commit 9e59ceae91c6 · 2018-06-22T13:33:06.000-04:00
The doc block is no longer required. But if it exists ensure it's formatted properly
diff --git a/Chadicus/Sniffs/Commenting/ClassCommentSniff.php b/Chadicus/Sniffs/Commenting/ClassCommentSniff.php
@@ -45,7 +45,7 @@ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
         if ($tokens[$commentEnd]['code'] !== T_DOC_COMMENT_CLOSE_TAG
             && $tokens[$commentEnd]['code'] !== T_COMMENT
         ) {
-            $phpcsFile->addError('Missing class doc comment', $stackPtr, 'Missing');
+            //Don't require the class doc block.
             return;
         }
 

Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)`
`45`	`45`	`if ($tokens[$commentEnd]['code'] !== T_DOC_COMMENT_CLOSE_TAG`
`46`	`46`	`&& $tokens[$commentEnd]['code'] !== T_COMMENT`
`47`	`47`	`) {`
`48`		`- $phpcsFile->addError('Missing class doc comment', $stackPtr, 'Missing');`
	`48`	`+ //Don't require the class doc block.`
`49`	`49`	`return;`
`50`	`50`	`}`
`51`	`51`