Source Location: /PHP_CodeSniffer-1.3.0/CodeSniffer/Standards/PEAR/Sniffs/Commenting/FileCommentSniff.php
$commentParser = null
[line 54]
The header comment parser for the current file.
Type:
PHP_CodeSniffer_Comment_Parser_ClassCommentParser
$currentFile = null
[line 61]
The current PHP_CodeSniffer_File object we are processing.
$tags = array(
'category' => array(
'required' => true,
'allow_multiple' => false,
'order_text' => 'precedes @package',
),'package'=>array('required'=>true,'allow_multiple'=>false,'order_text'=>'follows @category',),'subpackage'=>array('required'=>false,'allow_multiple'=>false,'order_text'=>'follows @package',),'author'=>array('required'=>true,'allow_multiple'=>true,'order_text'=>'follows @subpackage (if used) or @package',),'copyright'=>array('required'=>false,'allow_multiple'=>true,'order_text'=>'follows @author',),'license'=>array('required'=>true,'allow_multiple'=>false,'order_text'=>'follows @copyright (if used) or @author',),'version'=>array('required'=>false,'allow_multiple'=>false,'order_text'=>'follows @license',),'link'=>array('required'=>true,'allow_multiple'=>true,'order_text'=>'follows @version',),'see'=>array('required'=>false,'allow_multiple'=>true,'order_text'=>'follows @link',),'since'=>array('required'=>false,'allow_multiple'=>false,'order_text'=>'follows @see (if used) or @link',),'deprecated'=>array('required'=>false,'allow_multiple'=>false,'order_text'=>'follows @since (if used) or @see (if used) or @link',),)
[line 68]
Tags in correct order and related info.
getIndentation [line 522]
Get the indentation information of each tag.
Parameters:
string
$tagName
—
The name of the doc comment element.
process [line 148]
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.
processAuthors [line 668]
void processAuthors(
int
$commentStart)
Process the author tag(s) that this header comment has.
This function is different from other _process functions as $authors is an array of SingleElements, so we work out the errorPos for each element separately
Parameters:
int
$commentStart
—
The position in the stack where the comment started.
processCategory [line 546]
void processCategory(
int
$errorPos)
Process the category tag.
Parameters:
int
$errorPos
—
The line number where the error occurs.
processCopyrights [line 705]
void processCopyrights(
int
$commentStart)
Process the copyright tags.
Parameters:
int
$commentStart
—
The position in the stack where the comment started.
processLicense [line 746]
void processLicense(
int
$errorPos)
Process the license tag.
Parameters:
int
$errorPos
—
The line number where the error occurs.
processPackage [line 585]
void processPackage(
int
$errorPos)
Process the package tag.
Parameters:
int
$errorPos
—
The line number where the error occurs.
processPHPVersion [line 334]
void processPHPVersion(
int
$commentStart, int
$commentEnd, string
$commentText)
Check that the PHP version is specified.
Parameters:
int
$commentStart
—
Position in the stack where the comment started.
int
$commentEnd
—
Position in the stack where the comment ended.
string
$commentText
—
The text of the function comment.
processSubpackage [line 624]
void processSubpackage(
int
$errorPos)
Process the subpackage tag.
Parameters:
int
$errorPos
—
The line number where the error occurs.
processTags [line 352]
void processTags(
int
$commentStart, int
$commentEnd)
Processes each required or optional tag.
Parameters:
int
$commentStart
—
Position in the stack where the comment started.
int
$commentEnd
—
Position in the stack where the comment ended.
processVersion [line 768]
register [line 132]