West/Sniffs/Commenting/ClassCommentSniff.php
public function process(File $phpcsFile, $stackPtr)
    {
        $tokens = $phpcsFile->getTokens();
        $find   = Tokens::$methodPrefixes;
        $find[] = T_WHITESPACE;

        $commentEnd = $phpcsFile->findPrevious($find, ($stackPtr - 1), null, true);
        if ($tokens[$commentEnd]['code'] !== T_DOC_COMMENT_CLOSE_TAG
            && $tokens[$commentEnd]['code'] !== T_COMMENT
        ) {
            $class = $phpcsFile->getDeclarationName($stackPtr);
            $phpcsFile->addError('Missing doc comment for class %s', $stackPtr, 'Missing', [$class]);
            $phpcsFile->recordMetric($stackPtr, 'Class has doc comment', 'no');
            return;
        }

        $phpcsFile->recordMetric($stackPtr, 'Class has doc comment', 'yes');

        if ($tokens[$commentEnd]['code'] === T_COMMENT) {
            $phpcsFile->addError('You must use "/**" style comments for a class comment', $stackPtr, 'WrongStyle');
            return;
        }

        if ($tokens[$commentEnd]['line'] !== ($tokens[$stackPtr]['line'] - 1)) {
            $error = 'There must be no blank lines after the class comment';
            $phpcsFile->addError($error, $commentEnd, 'SpacingAfter');
        }
    }
public function process(File $phpcsFile, $stackPtr)
    {
        $tokens = $phpcsFile->getTokens();
        $find   = Tokens::$methodPrefixes;
        $find[] = T_WHITESPACE;

        $commentEnd = $phpcsFile->findPrevious($find, ($stackPtr - 1), null, true);
        if ($tokens[$commentEnd]['code'] !== T_DOC_COMMENT_CLOSE_TAG
            && $tokens[$commentEnd]['code'] !== T_COMMENT
        ) {
            $class = $phpcsFile->getDeclarationName($stackPtr);
            $phpcsFile->addError('Missing doc comment for class %s', $stackPtr, 'Missing', [$class]);
            $phpcsFile->recordMetric($stackPtr, 'Class has doc comment', 'no');
            return;
        }

        $phpcsFile->recordMetric($stackPtr, 'Class has doc comment', 'yes');

        if ($tokens[$commentEnd]['code'] === T_COMMENT) {
            $phpcsFile->addError('You must use "/**" style comments for a class comment', $stackPtr, 'WrongStyle');
            return;
        }

        if ($tokens[$commentEnd]['line'] !== ($tokens[$stackPtr]['line'] - 1)) {
            $error = 'There must be no blank lines after the class comment';
            $phpcsFile->addError($error, $commentEnd, 'SpacingAfter');
        }
    }
public function process ( File $ phpcsFile , $ stackPtr ) { $ tokens = $ phpcsFile -> getTokens ( ) ; $ find = Tokens :: $ methodPrefixes ; $ find [ ] = T_WHITESPACE ; $ commentEnd = $ phpcsFile -> findPrevious ( $ find , ( $ stackPtr - 1 ) , null , true ) ; if ( $ tokens [ $ commentEnd ] [ 'code' ] !== T_DOC_COMMENT_CLOSE_TAG && $ tokens [ $ commentEnd ] [ 'code' ] !== T_COMMENT ) { $ class = $ phpcsFile -> getDeclarationName ( $ stackPtr ) ; $ phpcsFile -> addError ( 'Missing doc comment for class %s' , $ stackPtr , 'Missing' , [ $ class ] ) ; $ phpcsFile -> recordMetric ( $ stackPtr , 'Class has doc comment' , 'no' ) ; return ; } $ phpcsFile -> recordMetric ( $ stackPtr , 'Class has doc comment' , 'yes' ) ; if ( $ tokens [ $ commentEnd ] [ 'code' ] === T_COMMENT ) { $ phpcsFile -> addError ( 'You must use "/**" style comments for a class comment' , $ stackPtr , 'WrongStyle' ) ; return ; } if ( $ tokens [ $ commentEnd ] [ 'line' ] !== ( $ tokens [ $ stackPtr ] [ 'line' ] - 1 ) ) { $ error = 'There must be no blank lines after the class comment' ; $ phpcsFile -> addError ( $ error , $ commentEnd , 'SpacingAfter' ) ; } }
{@inheritdoc}
{