Packages:
PHP_CodeSniffer

Classes:

Files:

AbstractDocElement.php
AbstractParser.php
AbstractPatternSniff.php
AbstractScopeSniff.php
AbstractVariableSniff.php
ArrayDeclarationSniff.php
BlockCommentSniff.php
ClassCommentParser.php
ClassCommentSniff.php
ClassCommentSniff.php
ClassDeclarationSniff.php
ClassFileNameSniff.php
ClosingDeclarationCommentSniff.php
CodeSniffer.php
CodingStandard.php
CommentElement.php
ComparisonOperatorUsageSniff.php
ConcatenationSpacingSniff.php
ControlSignatureSniff.php
ControlSignatureSniff.php
ControlStructureSpacingSniff.php
DisallowObEndFlushSniff.php
DisallowShortOpenTagSniff.php
DocCommentAlignmentSniff.php
DocElement.php
DoubleQuoteUsageSniff.php
EchoedStringsSniff.php
ElseIfDeclarationSniff.php
EmbeddedPhpSniff.php
EmptyCatchCommentSniff.php
Exception.php
File.php
FileCommentSniff.php
FileCommentSniff.php
FileExtensionSniff.php
ForbiddenFunctionsSniff.php
ForbiddenFunctionsSniff.php
ForEachLoopDeclarationSniff.php
ForLoopDeclarationSniff.php
FunctionCallArgumentSpacingSniff.php
FunctionCallSignatureSniff.php
FunctionClosingBraceSpaceSniff.php
FunctionCommentParser.php
FunctionCommentSniff.php
FunctionCommentSniff.php
FunctionCommentThrowTagSniff.php
FunctionDeclarationArgumentSpacingSniff.php
FunctionDeclarationSniff.php
FunctionSpacingSniff.php
GenericCodingStandard.php
GlobalFunctionSniff.php
GlobalKeywordSniff.php
HeredocSniff.php
IncludingFileSniff.php
IncorrectPatternException.php
IncrementDecrementUsageSniff.php
InlineCommentSniff.php
InlineCommentSniff.php
InlineControlStructureSniff.php
InlineIfDeclarationSniff.php
InnerFunctionsSniff.php
LineLengthSniff.php
LineLengthSniff.php
LineLengthSniff.php
LongConditionClosingCommentSniff.php
LowerCaseConstantSniff.php
MemberCommentParser.php
MemberVarScopeSniff.php
MemberVarSpacingSniff.php
MethodScopeSniff.php
MultipleStatementAlignmentSniff.php
MultipleStatementAlignmentSniff.php
OpeningFunctionBraceBsdAllmanSniff.php
OpeningFunctionBraceKernighanRitchieSniff.php
OperatorBracketSniff.php
OperatorSpacingSniff.php
OutputBufferingIndentSniff.php
PairElement.php
ParameterElement.php
ParserException.php
PEARCodingStandard.php
PostStatementCommentSniff.php
ScopeClosingBraceSniff.php
ScopeIndentSniff.php
ScopeIndentSniff.php
ScopeIndentSniff.php
SelfMemberReferenceSniff.php
SingleElement.php
Sniff.php
SniffException.php
SquizCodingStandard.php
StaticThisUsageSniff.php
SuperfluousWhitespaceSniff.php
SwitchDeclarationSniff.php
Tokens.php
UpperCaseConstantNameSniff.php
UpperCaseConstantSniff.php
ValidClassNameSniff.php
ValidClassNameSniff.php
ValidDefaultValueSniff.php
ValidFunctionNameSniff.php
ValidFunctionNameSniff.php
ValidInterfaceNameSniff.php
ValidLogicalOperatorsSniff.php
ValidVariableNameSniff.php
VariableCommentSniff.php

Class: Squiz_Sniffs_Commenting_FunctionCommentSniff

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

Copyright:

2006 Squiz Pty Ltd (ABN 77 084 670 600)

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

[line 49]
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: 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 86]

The function comment parser for the current method.

Access: protected

Type:

PHP_CodeSniffer_Comment_Parser_FunctionCommentParser

[ Top ]

$currentFile = null

[line 93]

The current PHP_CodeSniffer_File object we are processing.

Access: protected

Type:

PHP_CodeSniffer_File

[ Top ]

Method Detail

process [line 117]

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 ]

register [line 101]

array register(
)

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

Access: public

[ Top ]