Docs For Class Squiz_Sniffs_Commenting

[line 45]
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.

Author: Marc McIntyre <mmcintyre@squiz.net>
Author: Greg Sherwood <gsherwood@squiz.net>
Version: Release: 0.7.0
Copyright: 2006 Squiz Pty Ltd (ABN 77 084 670 600)
Link: http://pear.php.net/package/PHP_CodeSniffer
License: BSD Licence

process [line 84]

void process(
PHP_CodeSniffer_File
$phpcsFile, int
$stackPtr)

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

Access: public

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 468]

void processAuthors(
int
$errorPos)

Author tag must be 'Squiz Pty Ltd <mysource4@squiz.net>'.

Access: protected

Parameters:

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

[ Top ]

processCopyright [line 493]

void processCopyright(
int
$errorPos)

Access: protected

Parameters:

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

[ Top ]

processLicense [line 518]

void processLicense(
int
$errorPos)

License tag must be 'http://matrix.squiz.net/licence Squiz.Net Open Source Licence'.

Access: protected

Parameters:

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

[ Top ]

processPackage [line 410]

void processPackage(
int
$errorPos)

The package name must be 'MySource4'.

Access: protected

Parameters:

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

[ Top ]

processSubpackage [line 434]

void processSubpackage(
int
$errorPos)

The subpackage name must be camel-cased.

Access: protected

Parameters:

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

[ Top ]

processTags [line 252]

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 383]

void processVersion(
int
$errorPos)

The version tag must have the exact keyword 'release_version'.

Access: protected

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

[ Top ]

Class: Squiz_Sniffs_Commenting_FileCommentSniff

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$commentParser = null

$currentFile = null

Method Detail

process [line 84]

Parameters:

processAuthors [line 468]

Parameters:

processCopyright [line 493]

Parameters:

processLicense [line 518]

Parameters:

processPackage [line 410]

Parameters:

processSubpackage [line 434]

Parameters:

processTags [line 252]

Parameters:

processVersion [line 383]

Parameters:

register [line 68]