namespace Drupal\Sniffs\Commenting
| Object name | File name | Summary |
|---|---|---|
| ClassCommentSniff | vendor/drupal/coder/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 | vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/Commenting/DataTypeNamespaceSniff.php | Checks that data types in param, return, var, and throws tags are fully namespaced. |
| DeprecatedSniff | vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/Commenting/DeprecatedSniff.php | Ensures standard format of @ deprecated tag text in docblock. |
| DocCommentAlignmentSniff | vendor/drupal/coder/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 |
| DocCommentLongArraySyntaxSniff | vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/Commenting/DocCommentLongArraySyntaxSniff.php | Ensures @code annotations in doc blocks don't contain long array syntax. |
| DocCommentSniff | vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/Commenting/DocCommentSniff.php | Ensures doc blocks follow basic formatting. |
| DocCommentStarSniff | vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/Commenting/DocCommentStarSniff.php | Checks that a doc comment block has a doc comment star on every line. |
| FileCommentSniff | vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/Commenting/FileCommentSniff.php | Parses and verifies the doc comments for files. |
| FunctionCommentSniff | vendor/drupal/coder/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 | vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/Commenting/GenderNeutralCommentSniff.php | Parses and verifies that comments use gender neutral language. |
| HookCommentSniff | vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/Commenting/HookCommentSniff.php | Ensures hook comments on function are correct. |
| InlineCommentSniff | vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/Commenting/InlineCommentSniff.php | \Drupal\Sniffs\Commenting\InlineCommentSniff. |
| InlineVariableCommentSniff | vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/Commenting/InlineVariableCommentSniff.php | Checks for the correct usage of inline variable type declarations. |
| PostStatementCommentSniff | vendor/drupal/coder/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 | vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/Commenting/TodoCommentSniff.php | Parses and verifies that comments use the correct @todo format. |
| VariableCommentSniff | vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/Commenting/VariableCommentSniff.php | Parses and verifies class property doc comments. |