function DocCommentHelper::getDocComment

1 call to DocCommentHelper::getDocComment()

DocCommentHelper::parseDocComment in vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/DocCommentHelper.php

File

vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/DocCommentHelper.php, line 56

Class

DocCommentHelper

@internal

Namespace

SlevomatCodingStandard\Helpers

Code

public static function getDocComment(File $phpcsFile, int $pointer) : ?string {
    $docCommentOpenToken = self::findDocCommentOpenPointer($phpcsFile, $pointer);
    if ($docCommentOpenToken === null) {
        return null;
    }
    return trim(TokenHelper::getContent($phpcsFile, $docCommentOpenToken, $phpcsFile->getTokens()[$docCommentOpenToken]['comment_closer']));
}