You are here

namespace Drupal\Sniffs\Commenting in Coder 8.3.x

Same name in other branches
  1. 8.3 Drupal\Sniffs\Commenting
  2. 8.2 Drupal\Sniffs\Commenting
Classsort descending Location Description
ClassCommentSniff coder_sniffer/Drupal/Sniffs/Commenting/ClassCommentSniff.php Checks that comment doc blocks exist on classes, interfaces and traits. Largely copied from PHP_CodeSniffer\Standards\Squiz\Sniffs\Commenting\ClassCommentSniff.
DataTypeNamespaceSniff coder_sniffer/Drupal/Sniffs/Commenting/DataTypeNamespaceSniff.php Checks that data types in param, return, var, and throws tags are fully namespaced.
DeprecatedSniff coder_sniffer/Drupal/Sniffs/Commenting/DeprecatedSniff.php Ensures standard format of @ deprecated tag text in docblock.
DocCommentAlignmentSniff coder_sniffer/Drupal/Sniffs/Commenting/DocCommentAlignmentSniff.php Largely copied from \PHP_CodeSniffer\Standards\Squiz\Sniffs\Commenting\DocCommentAlignmentSniff to also handle the "var" keyword. See https://github.com/squizlabs/PHP_CodeSniffer/pull/1212
DocCommentSniff coder_sniffer/Drupal/Sniffs/Commenting/DocCommentSniff.php Ensures doc blocks follow basic formatting.
DocCommentStarSniff coder_sniffer/Drupal/Sniffs/Commenting/DocCommentStarSniff.php Checks that a doc comment block has a doc comment star on every line.
FileCommentSniff coder_sniffer/Drupal/Sniffs/Commenting/FileCommentSniff.php Parses and verifies the doc comments for files.
FunctionCommentSniff coder_sniffer/Drupal/Sniffs/Commenting/FunctionCommentSniff.php Parses and verifies the doc comments for functions. Largely copied from PHP_CodeSniffer\Standards\Squiz\Sniffs\Commenting\FunctionCommentSniff.
GenderNeutralCommentSniff coder_sniffer/Drupal/Sniffs/Commenting/GenderNeutralCommentSniff.php Parses and verifies that comments use gender neutral language.
HookCommentSniff coder_sniffer/Drupal/Sniffs/Commenting/HookCommentSniff.php Ensures hook comments on function are correct.
InlineCommentSniff coder_sniffer/Drupal/Sniffs/Commenting/InlineCommentSniff.php \Drupal\Sniffs\Commenting\InlineCommentSniff.
InlineVariableCommentSniff coder_sniffer/Drupal/Sniffs/Commenting/InlineVariableCommentSniff.php Checks for the correct usage of inline variable type declarations.
PostStatementCommentSniff coder_sniffer/Drupal/Sniffs/Commenting/PostStatementCommentSniff.php Largely copied from \PHP_CodeSniffer\Standards\Squiz\Sniffs\Commenting\PostStatementCommentSniff but we want the fixer to move the comment to the previous line.
TodoCommentSniff coder_sniffer/Drupal/Sniffs/Commenting/TodoCommentSniff.php Parses and verifies that comments use the correct @todo format.
VariableCommentSniff coder_sniffer/Drupal/Sniffs/Commenting/VariableCommentSniff.php Parses and verifies class property doc comments.