Class: Squiz_Sniffs_Commenting_ClassCommentSniff
Source Location: /PHP_CodeSniffer-2.0.0RC2/CodeSniffer/Standards/Squiz/Sniffs/Commenting/ClassCommentSniff.php
Parses and verifies the class doc comment.
Author(s):
Version:
Copyright:
- 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)
Inherited Variables
Inherited Methods
Class Details
[line 35]
Parses and verifies the class doc comment.
Verifies that :
- A class doc comment exists.
- There is exactly one blank line before the class comment.
- There are no blank lines after the class comment.
- Short and long descriptions end with a full stop and start with capital letter.
- There is a blank line between descriptions.
Method Detail
process [line 60]
Processes this test, when one of its tokens is encountered.
Parameters:
int
$stackPtr
—
The position of the current token in the stack passed in $tokens.
register [line 44]
Returns an array of tokens this test wants to listen for.
Documentation generated on 2019年3月11日 15:58:45 -0400 by
phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.