BlueSpice MediaWiki master
 All Classes Namespaces Files Functions Variables Groups Pages
PHP_CodeSniffer\Standards\Squiz\Sniffs\Commenting Namespace Reference

Classes

class  BlockCommentSniff
 
class  ClassCommentSniff
 
class  ClosingDeclarationCommentSniff
 
class  DocCommentAlignmentSniff
 
class  EmptyCatchCommentSniff
 
class  FileCommentSniff
 
class  FunctionCommentSniff
 
class  FunctionCommentThrowTagSniff
 
class  InlineCommentSniff
 
class  LongConditionClosingCommentSniff
 
class  PostStatementCommentSniff
 
class  VariableCommentSniff
 

Detailed Description

Verifies that block comments are used appropriately.

Author
Greg Sherwood gsher.nosp@m.wood.nosp@m.@squi.nosp@m.z.ne.nosp@m.t

Parses and verifies the class doc comment.

Verifies that :

  • A class doc comment exists.
  • The comment uses the correct docblock style.
  • There are no blank lines after the class comment.
  • No tags are used in the docblock.
Author
Greg Sherwood gsher.nosp@m.wood.nosp@m.@squi.nosp@m.z.ne.nosp@m.t

Checks the //end ... comments on classes, interfaces and functions.

Author
Greg Sherwood gsher.nosp@m.wood.nosp@m.@squi.nosp@m.z.ne.nosp@m.t

Tests that the stars in a doc comment align correctly.

Author
Greg Sherwood gsher.nosp@m.wood.nosp@m.@squi.nosp@m.z.ne.nosp@m.t

Checks for empty catch clause without a comment.

Author
Greg Sherwood gsher.nosp@m.wood.nosp@m.@squi.nosp@m.z.ne.nosp@m.t

Parses and verifies the file doc comment.

Author
Greg Sherwood gsher.nosp@m.wood.nosp@m.@squi.nosp@m.z.ne.nosp@m.t

Parses and verifies the doc comments for functions.

Author
Greg Sherwood gsher.nosp@m.wood.nosp@m.@squi.nosp@m.z.ne.nosp@m.t

Verifies that a

Exceptions
tagexists for each exception type a function throws.
Author
Greg Sherwood gsher.nosp@m.wood.nosp@m.@squi.nosp@m.z.ne.nosp@m.t

Checks that there is adequate spacing between comments.

Author
Greg Sherwood gsher.nosp@m.wood.nosp@m.@squi.nosp@m.z.ne.nosp@m.t

Ensures long conditions have a comment at the end.

Author
Greg Sherwood gsher.nosp@m.wood.nosp@m.@squi.nosp@m.z.ne.nosp@m.t

Checks to ensure that there are no comments after statements.

Author
Greg Sherwood gsher.nosp@m.wood.nosp@m.@squi.nosp@m.z.ne.nosp@m.t

Parses and verifies the variable doc comment.

Author
Greg Sherwood gsher.nosp@m.wood.nosp@m.@squi.nosp@m.z.ne.nosp@m.t