\Joomla_Sniffs_Commenting_ClassCommentSniff

Parses and verifies the doc comments for classes.

Verifies that :
<ul>
<li>A doc comment exists.</li>
<li>There is a blank newline after the short description.</li>
<li>There is a blank newline between the long and short description.</li>
<li>There is a blank newline between the long description and tags.</li>
<li>Check the order of the tags.</li>
<li>Check the indentation of each tag.</li>
<li>Check required and optional tags and the format of their content.</li>
</ul>

Synopsis

class Joomla_Sniffs_Commenting_ClassCommentSniff extends Joomla_Sniffs_Commenting_FileCommentSniff {
  • // members
  • protected  $tags;
  • // Inherited members from Joomla_Sniffs_Commenting_FileCommentSniff
  • protected PHP_CodeSniffer_Comment_Parser_ClassCommentParser  $commentParser;
  • protected PHP_CodeSniffer_File  $currentFile;
  • protected  $tags;
}

Hierarchy

Members

protected

Methods

protected

public

  • process() — Processes this test, when one of its tokens is encountered.
  • register() — Returns an array of tokens this test wants to listen for.

Inherited from Joomla_Sniffs_Commenting_FileCommentSniff

protected

public

  • process() — Processes this test, when one of its tokens is encountered.
  • register() — Returns an array of tokens this test wants to listen for.