Class: PEAR_Sniffs_Commenting_ClassCommentSniff

Source Location: /PHP_CodeSniffer-0.7.0/CodeSniffer/Standards/PEAR/Sniffs/Commenting/ClassCommentSniff.php

PEAR_Sniffs_Commenting_FileCommentSniff
   |
   --PEAR_Sniffs_Commenting_ClassCommentSniff

Parses and verifies the doc comments for classes.

PEAR_Sniffs_Commenting_FileCommentSniff::getIndentation(): Get the indentation information of each tag.
PEAR_Sniffs_Commenting_FileCommentSniff::process(): Processes this test, when one of its tokens is encountered.
PEAR_Sniffs_Commenting_FileCommentSniff::processAuthors(): Process the author tag(s) that this header comment has.
PEAR_Sniffs_Commenting_FileCommentSniff::processCategory(): Process the category tag.
PEAR_Sniffs_Commenting_FileCommentSniff::processCopyright(): Process the copyright tag.
PEAR_Sniffs_Commenting_FileCommentSniff::processLicense(): Process the license tag.
PEAR_Sniffs_Commenting_FileCommentSniff::processPackage(): Process the package tag.
PEAR_Sniffs_Commenting_FileCommentSniff::processTags(): Processes each required or optional tag.
PEAR_Sniffs_Commenting_FileCommentSniff::processVersion(): Process the version tag.
PEAR_Sniffs_Commenting_FileCommentSniff::register(): Returns an array of tokens this test wants to listen for.

[line 44]
Parses and verifies the doc comments for classes.

Verifies that :

[ Top ]

void process(
PHP_CodeSniffer_File
$phpcsFile, int
$stackPtr)

Processes this test, when one of its tokens is encountered.

Overrides PEAR_Sniffs_Commenting_FileCommentSniff::process() (Processes this test, when one of its tokens is encountered.)

PHP_CodeSniffer_File	`$phpcsFile`	—	The file being scanned.
int	`$stackPtr`	—	The position of the current token in the stack passed in $tokens.

[ Top ]

void processVersion(
int
$errorPos)

Process the version tag.

int $errorPos — The line number where the error occurs.

[ Top ]

array register(
)

Returns an array of tokens this test wants to listen for.

Overrides PEAR_Sniffs_Commenting_FileCommentSniff::register() (Returns an array of tokens this test wants to listen for.)

[ Top ]