Class: Squiz_Sniffs_Commenting_ClassCommentSniff
Source Location: /PHP_CodeSniffer-0.8.0/CodeSniffer/Standards/Squiz/Sniffs/Commenting/ClassCommentSniff.php
Parses and verifies the class doc comment.
Author(s):
Version:
Copyright:
- 2006 Squiz Pty Ltd (ABN 77 084 670 600)
Inherited Variables
Inherited Methods
Class Details
[line 44]
Parses and verifies the class doc comment.
Verifies that :
- A class doc comment exists.
- There is exactly one blank line before the class comment.
- Short description ends with a full stop.
- There is a blank line after the short description.
- Each paragraph of the long description ends with a full stop.
- There is a blank line between the description and the tags.
- Check the format of the since tag (x.x.x).
Method Detail
process [line 69]
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.
processSince [line 294]
void processSince(
int
$errorPos)
Processes the since tag.
The since tag must have the exact keyword 'release_version' or is in the form x.x.x
Parameters:
int
$errorPos
—
The line number where the error occurs.
processTags [line 234]
void processTags(
int
$commentStart, int
$commentEnd)
Processes each required or optional tag.
Parameters:
int
$commentStart
—
The position in the stack where the comment started.
int
$commentEnd
—
The position in the stack where the comment ended.
register [line 53]
Returns an array of tokens this test wants to listen for.
Documentation generated on 2019年3月11日 14:44:45 -0400 by
phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.