function coder_review_comment_reviews in Coder 7
Same name and namespace in other branches
- 7.2 coder_review/includes/coder_review_comment.inc \coder_review_comment_reviews()
Implements hook_reviews().
File
- coder_review/
includes/ coder_review_comment.inc, line 11 - This include file implements coder functionality for comments.
Code
function coder_review_comment_reviews() {
$rules = array(
array(
'#type' => 'grep',
'#source' => 'comment',
'#value' => '$Id',
'#case-sensitive' => TRUE,
'#warning_callback' => '_coder_review_comment_Id_warning',
'#severity' => 'minor',
),
array(
'#type' => 'regex',
'#source' => 'comment',
'#value' => '^\\*',
'#warning' => 'indent secondary line of comment one space ',
'#severity' => 'minor',
),
array(
'#type' => 'regex',
'#source' => 'comment',
'#value' => '^\\s*\\*.+|^\\/\\*.+',
'#not' => '^\\s*\\*\\s+|^\\/\\*\\s+|^\\/\\*\\*|^\\s*\\*\\/',
'#warning' => 'put a space between the asterisk and the comment text',
'#severity' => 'minor',
),
array(
'#type' => 'regex',
'#source' => 'comment',
'#value' => '.*\\@see\\s*',
'#not' => '^(\\s*\\*|\\/\\/)\\s*\\@see.*$',
'#warning' => '@see should always be at the beginning of a line, never inline in other comments.',
'#severity' => 'minor',
),
array(
'#type' => 'regex',
'#source' => 'comment',
'#value' => '\\@see\\s*.*',
'#not' => '^\\@see\\s+((\\w+\\(\\)|[\\w\\.\\-\\?\\/:\\&=]+\\.[\\w\\.\\->\\?\\/:\\&=]+)[,\\s]+)*(\\w+\\(\\)|[\\w\\.\\->\\?\\/:\\&=]+\\.[\\w\\.\\->\\?\\/:\\&=]+)\\W*$',
'#warning' => '@see should always be followed by a filename, a URL, class/interface name (optionally including method), or a function name including ().',
'#severity' => 'minor',
),
array(
'#type' => 'regex',
'#source' => 'comment',
'#value' => '\\@see\\s*\\w+.*$',
'#not' => '^\\@see\\s+([\\w\\.\\-\\(\\)\\?\\/:\\&=]+,\\s)*[\\w\\.\\-\\(\\)\\?\\/:\\&=]+?[\\w\\(\\)\\/]$',
'#warning' => '@see references should be separated by "," followed by a single space and with no trailing punctuation',
'#severity' => 'minor',
),
array(
'#type' => 'regex',
'#source' => 'comment',
'#value' => '\\@see\\s.*$',
'#not' => '^\\@see [^\\s]',
'#warning' => '@see should be separated from the references by one space only',
'#severity' => 'minor',
),
array(
'#type' => 'grep_invert',
'#source' => 'comment',
'#value' => '@' . 'file',
'#warning_callback' => '_coder_review_comment_missing_file_block_warning',
'#filename-not' => array(
'patch',
),
),
array(
'#type' => 'callback',
'#value' => '_coder_review_comment_install_file_block_callback',
// @NOTE: This is not used. It only exists to catch potential errors in this code.
'#warning_callback' => '_coder_review_comment_install_file_callback_warning',
),
array(
'#type' => 'regex',
'#source' => 'comment',
'#value' => '@' . 'file\\s+.+$',
'#warning_callback' => '_coder_review_comment_invalid_file_block_warning',
'#severity' => 'minor',
),
array(
'#type' => 'regex',
'#source' => 'comment',
'#value' => 'Implements*\\s+hook_\\w+\\(\\)\\s*$',
'#warning' => 'Missing period',
'#severity' => 'minor',
),
array(
'#type' => 'regex',
'#source' => 'comment',
'#value' => 'Implements*\\s+hook_\\w+\\s*\\.*$',
'#warning' => 'Missing parenthesis after function name',
'#severity' => 'minor',
),
array(
'#type' => 'regex',
'#source' => 'comment',
'#value' => '\\s*Implementation\\s+of\\s+hook_\\w+',
'#warning' => 'Comment should be read "Implements hook_foo()."',
'#severity' => 'minor',
),
array(
'#type' => 'regex',
'#source' => 'comment',
'#value' => '^.*?\\*\\s*Implements\\s+hook_\\w+\\(\\)\\.',
'#not' => '^\\s\\*\\sImplements*\\s+hook_\\w+',
'#warning' => 'Format should be <code>* Implements hook_foo().</code>',
'#severity' => 'minor',
),
array(
'#type' => 'regex',
'#source' => 'comment',
'#value' => '\\/\\/\\s*Implements\\s+hook_\\w+\\(\\)\\.',
'#warning' => 'Implements comment should be in a comment block.',
'#severity' => 'minor',
),
array(
'#type' => 'regex',
'#source' => 'comment',
'#value' => 'implements\\s+hook_\\w+',
'#warning' => '\'Implements\' should be at the start of the sentence and begin with a capitialized letter',
'#severity' => 'minor',
'#case-sensitive' => TRUE,
),
);
$review = array(
'#title' => t('Drupal Commenting Standards'),
'#link' => 'http://drupal.org/node/318',
'#rules' => $rules,
'#description' => t('every developer should use'),
);
return array(
'comment' => $review,
);
}