PHP_CodeSniffer
[ class tree: PHP_CodeSniffer ] [ index: PHP_CodeSniffer ] [ all elements ]

Class: Squiz_Sniffs_Commenting_ClassCommentSniff

Source Location: /PHP_CodeSniffer-0.6.0/CodeSniffer/Standards/Squiz/Sniffs/Commenting/ClassCommentSniff.php

Class Overview


Parses and verifies the class doc comment.


Author(s):

Version:

  • Release: 0.6.0

Copyright:

  • 2006 Squiz Pty Ltd (ABN 77 084 670 600)

Methods


Inherited Variables

Inherited Methods


Class Details

[line 43]
Parses and verifies the class doc comment.

Verifies that :

  • A class doc comment exists.
  • There is exactly one blank line before the class 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 format of the since tag (x.x.x).



[ Top ]


Method Detail

process   [line 68]

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 ]

processTags   [line 232]

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

array register( )

Returns an array of tokens this test wants to listen for.
  • Access: public

[ Top ]


Documentation generated on Mon, 11 Mar 2019 15:01:59 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.