Docs For Class PEAR_Sniffs_Commenting

getIndentation [line 410]

void getIndentation(
string
$tagName, PHP_CodeSniffer_CommentParser_DocElement
$tagElement)

Get the indentation information of each tag.

Access: protected

Parameters:

string	`$tagName`	—	The name of the doc comment element.
PHP_CodeSniffer_CommentParser_DocElement	`$tagElement`	—	The doc comment element.

[ Top ]

process [line 84]

void process(
PHP_CodeSniffer_File
$phpcsFile, int
$stackPtr)

Processes this test, when one of its tokens is encountered.

Access: public

Overridden in child classes as:

PEAR_Sniffs_Commenting_ClassCommentSniff::process(): Processes this test, when one of its tokens is encountered.

Parameters:

PHP_CodeSniffer_File	`$phpcsFile`	—	The file being scanned.
int	`$stackPtr`	—	The position of the current token in the stack passed in $tokens.

[ Top ]

processAuthors [line 507]

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

Access: protected

Parameters:

int $commentStart — The position in the stack where the comment started..

[ Top ]

processCategory [line 434]

void processCategory(
int
$errorPos)

Process the category tag.

Access: protected

Parameters:

int $errorPos — The line number where the error occurs.

[ Top ]

processCopyright [line 541]

void processCopyright(
int
$errorPos)

Process the copyright tag.

Access: protected

Parameters:

int $errorPos — The line number where the error occurs.

[ Top ]

processLicense [line 581]

void processLicense(
int
$errorPos)

Process the license tag.

Access: protected

Parameters:

int $errorPos — The line number where the error occurs.

[ Top ]

processPackage [line 468]

void processPackage(
int
$errorPos)

Process the package tag.

Access: protected

Parameters:

int $errorPos — The line number where the error occurs.

[ Top ]

processTags [line 229]

void processTags(
int
$commentStart, int
$commentEnd)

Processes each required or optional tag.

Access: protected

Parameters:

int	`$commentStart`	—	The position in the stack where the comment started.
int	`$commentEnd`	—	The position in the stack where the comment ended.

[ Top ]

processVersion [line 603]

void processVersion(
int
$errorPos)

Process the version tag.

Access: protected

Overridden in child classes as:

PEAR_Sniffs_Commenting_ClassCommentSniff::processVersion(): Process the version tag.

Parameters:

int $errorPos — The line number where the error occurs.

[ Top ]

register [line 68]

array register(
)

Returns an array of tokens this test wants to listen for.

Access: public

Overridden in child classes as:

PEAR_Sniffs_Commenting_ClassCommentSniff::register(): Returns an array of tokens this test wants to listen for.

[ Top ]

Class: PEAR_Sniffs_Commenting_FileCommentSniff

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Child classes:

Inherited Variables

Inherited Methods

Class Details

Class Variables

$commentParser = null

$currentFile = null

Method Detail

getIndentation [line 410]

Parameters:

process [line 84]

Parameters:

processAuthors [line 507]

Parameters:

processCategory [line 434]

Parameters:

processCopyright [line 541]

Parameters:

processLicense [line 581]

Parameters:

processPackage [line 468]

Parameters:

processTags [line 229]

Parameters:

processVersion [line 603]

Parameters:

register [line 68]