Class: PEAR_Sniffs_Commenting_FileCommentSniff
Source Location: /PHP_CodeSniffer-0.5.0/CodeSniffer/Standards/PEAR/Sniffs/Commenting/FileCommentSniff.php
Parses and verifies the doc comments for files.
Author(s):
Version:
Copyright:
- 2006 Squiz Pty Ltd (ABN 77 084 670 600)
Child classes:
Inherited Variables
Inherited Methods
Class Details
[line 45]
Parses and verifies the doc comments for files.
Verifies that :
- A doc comment exists.
- There is a blank newline after the short description.
- There is a blank newline between the long and short description.
- There is a blank newline between the long description and tags.
- A PHP version is specified.
- Check the order of the tags.
- Check the indentation of each tag.
- Check required and optional tags and the format of their content.
Class Variables
$commentParser = null
[line 53]
The header comment parser for the current file.
Type:
PHP_CodeSniffer_Comment_Parser_ClassCommentParser
$currentFile = null
[line 60]
The current PHP_CodeSniffer_File object we are processing.
Method Detail
process [line 84]
Processes this test, when one of its tokens is encountered.
Overridden in child classes as:
- PEAR_Sniffs_Commenting_ClassCommentSniff::process()
- 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.
processTags [line 228]
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 68]
Documentation generated on 2019年3月11日 15:00:01 -0400 by
phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.