Class: PEAR_Sniffs_Commenting_FileCommentSniff

Source Location: /PHP_CodeSniffer-0.6.0/CodeSniffer/Standards/PEAR/Sniffs/Commenting/FileCommentSniff.php

Class Overview

Parses and verifies the doc comments for files.

Author(s):

Marc McIntyre <mmcintyre at squiz.net>
Greg Sherwood <gsherwood at squiz.net>

Version:

Release: 0.6.0

Copyright:

2006 Squiz Pty Ltd (ABN 77 084 670 600)

Variables

Methods

Child classes:

PEAR_Sniffs_Commenting_ClassCommentSniff: Parses and verifies the doc comments for 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.

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

[ Top ]

Class Variables

$commentParser = null

[line 53]

The header comment parser for the current file.

Access: protected

Type:

PHP_CodeSniffer_Comment_Parser_ClassCommentParser

[ Top ]

$currentFile = null

[line 60]

The current PHP_CodeSniffer_File object we are processing.

Access: protected

Type:

PHP_CodeSniffer_File

[ Top ]

Method Detail

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 ]

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 ]

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 ]