Class: Squiz_Sniffs_Commenting_FunctionCommentSniff

Source Location: /PHP_CodeSniffer-2.0.0a2/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: 2.0.0a2

Copyright:

2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)

Methods

Child classes:

MySource_Sniffs_Commenting_FunctionCommentSniff: Parses and verifies the doc comments for functions.

Inherited Variables

Inherited Methods

Class Details

[line 45]
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: 2.0.0a2
Copyright: 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)
Link: http://pear.php.net/package/PHP_CodeSniffer
License: BSD Licence

[ Top ]

Method Detail

process [line 70]

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:

MySource_Sniffs_Commenting_FunctionCommentSniff::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 ]

processParams [line 320]

void processParams(
PHP_CodeSniffer_File
$phpcsFile, int
$stackPtr, int
$commentStart)

Process the function parameter comments.

Access: protected

Parameters:

PHP_CodeSniffer_File $phpcsFile — The file being scanned.

int $stackPtr — The position of the current token in the stack passed in $tokens.

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

[ Top ]

processReturn [line 123]

void processReturn(
PHP_CodeSniffer_File
$phpcsFile, int
$stackPtr, int
$commentStart)

Process the return comment of this function comment.

Access: protected

Parameters:

PHP_CodeSniffer_File $phpcsFile — The file being scanned.

int $stackPtr — The position of the current token in the stack passed in $tokens.

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

[ Top ]

processThrows [line 251]

void processThrows(
PHP_CodeSniffer_File
$phpcsFile, int
$stackPtr, int
$commentStart)

Process any throw tags that this function comment has.

Access: protected

Parameters:

PHP_CodeSniffer_File $phpcsFile — The file being scanned.

int $stackPtr — The position of the current token in the stack passed in $tokens.

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

[ Top ]

register [line 54]

array register(
)

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

Access: public

[ Top ]