Source Location: /PHP_CodeSniffer-0.7.0/CodeSniffer/Standards/Squiz/Sniffs/Commenting/FileCommentSniff.php
$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.
process [line 84]
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 468]
void processAuthors(
int
$errorPos)
Author tag must be 'Squiz Pty Ltd <mysource4@squiz.net>'.
Parameters:
int
$errorPos
—
The line number where the error occurs.
processCopyright [line 493]
void processCopyright(
int
$errorPos)
Copyright tag must be in the form '2006-YYYY Squiz Pty Ltd (ABN 77 084 670 600)'.
Parameters:
int
$errorPos
—
The line number where the error occurs.
processLicense [line 518]
void processLicense(
int
$errorPos)
License tag must be 'http://matrix.squiz.net/licence Squiz.Net Open Source Licence'.
Parameters:
int
$errorPos
—
The line number where the error occurs.
processPackage [line 410]
void processPackage(
int
$errorPos)
The package name must be 'MySource4'.
Parameters:
int
$errorPos
—
The line number where the error occurs.
processSubpackage [line 434]
void processSubpackage(
int
$errorPos)
The subpackage name must be camel-cased.
Parameters:
int
$errorPos
—
The line number where the error occurs.
processTags [line 252]
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.
processVersion [line 383]
void processVersion(
int
$errorPos)
The version tag must have the exact keyword 'release_version'.
Parameters:
int
$errorPos
—
The line number where the error occurs.
register [line 68]
Returns an array of tokens this test wants to listen for.