Class: Squiz_Sniffs_Commenting_FunctionCommentSniff

Source Location: /PHP_CodeSniffer-1.1.0a1/CodeSniffer/Standards/Squiz/Sniffs/Commenting/FunctionCommentSniff.php

Class Overview

Parses and verifies the doc comments for functions.

Author(s):

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

Version:

Release: 1.1.0a1

Copyright:

2006 Squiz Pty Ltd (ABN 77 084 670 600)

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

[line 51]
Parses and verifies the doc comments for functions.

Verifies that :

A 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
Parameter names represent those in the method
Parameter comments are in the correct order
Parameter comments are complete
A type hint is provided for array and custom class
Type hint matches the actual variable/class type
A blank line is present before the first and after the last parameter
A return type exists
Any throw tag must have a comment
The tag order and indentation are correct

Author: Marc McIntyre <mmcintyre@squiz.net>
Author: Greg Sherwood <gsherwood@squiz.net>
Version: Release: 1.1.0a1
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 87]

The function comment parser for the current method.

Access: protected

Type:

PHP_CodeSniffer_Comment_Parser_FunctionCommentParser

[ Top ]

$currentFile = null

[line 94]

The current PHP_CodeSniffer_File object we are processing.

Access: protected

Type:

PHP_CodeSniffer_File

[ Top ]

Method Detail

process [line 118]

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 ]

processParams [line 571]

void processParams(
int
$commentStart, int
$commentEnd)

Process the function parameter comments.

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 ]

processReturn [line 397]

void processReturn(
int
$commentStart, int
$commentEnd)

Process the return comment of this function comment.

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 ]

processSees [line 353]

void processSees(
int
$commentStart)

Process the see tags.

Access: protected

Parameters:

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

[ Top ]

processSince [line 290]

void processSince(
int
$commentStart, int
$commentEnd)

Process the since 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 ]

processThrows [line 514]

void processThrows(
int
$commentStart)

Process any throw tags that this function comment has.

Access: protected

Parameters:

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

[ Top ]

register [line 102]

array register(
)

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

Access: public

[ Top ]