Class: Squiz_Sniffs_Commenting_FileCommentSniff
Source Location: /PHP_CodeSniffer-2.1.0/CodeSniffer/Standards/Squiz/Sniffs/Commenting/FileCommentSniff.php
Parses and verifies the file doc comment.
Author(s):
Version:
Copyright:
- 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)
Inherited Variables
Inherited Methods
Class Details
[line 41]
Parses and verifies the file doc comment.
Verifies that :
- A file doc comment exists.
- There is no blank line between the open tag and the file 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 order, indentation and content of each tag.
- There is exactly one blank line after the file comment.
Class Variables
$supportedTokenizers = array(
'PHP',
'JS',
)
[line 49]
A list of tokenizers this sniff supports.
Method Detail
process [line 76]
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 60]
Returns an array of tokens this test wants to listen for.
Documentation generated on 2019年3月11日 16:00:51 -0400 by
phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.