minor - applied commenting standards
authorStella Power
Wed, 30 Jan 2008 10:46:54 +0000 (10:46 +0000)
committerStella Power
Wed, 30 Jan 2008 10:46:54 +0000 (10:46 +0000)
includes/coder_47.inc
includes/coder_50.inc
includes/coder_6x.inc
includes/coder_comment.inc
includes/coder_security.inc
includes/coder_style.inc

index aa6b52c..efdef2b 100644 (file)
@@ -3,7 +3,7 @@
 
 /**
  * @file
- * This include file implements coder functionality for 4.6 -> 4.7 upgrades
+ * This include file implements coder functionality for 4.6 -> 4.7 upgrades.
  */
 
 /**
@@ -110,7 +110,7 @@ function coder_47_reviews() {
 }
 
 /**
- * Define the warning callbacks
+ * Define the warning callbacks.
  */
 
 function _coder_47_hook_node_info_warning() {
index 67ed121..a18b4a9 100644 (file)
@@ -85,13 +85,13 @@ function coder_50_reviews() {
 }
 
 /**
- * Define the rule callbacks for 5.x, see do_coder_review_callback()
+ * Define the rule callbacks for 5.x, see do_coder_review_callback().
  */
 function _coder_50_callback(&$coder_args, $review, $rule, $lines, &$results) {
-  // only perform this check on module's (not includes)
+  // Only perform this check on module's (not includes).
   $filename = $coder_args['#filename'];
   if (substr($filename, -7) == '.module') {
-    // make sure that a .info file exists
+    // Make sure that a .info file exists.
     $filename = drupal_substr(realpath($filename), 0, -7) .'.info';
     if (!file_exists($filename)) {
       $severity_name = _coder_severity_name($coder_args, $review, $rule);
@@ -102,7 +102,7 @@ function _coder_50_callback(&$coder_args, $review, $rule, $lines, &$results) {
 }
 
 /**
- * Define the warning callbacks
+ * Define the warning callbacks.
  */
 
 function _coder_50_user_mail_warning() {
index 9329d89..5878127 100644 (file)
@@ -104,7 +104,7 @@ function coder_6x_reviews() {
       '#type' => 'callback',
       '#value' => '_coder_6x_callback',
     ),
-    // FAPI Rules
+    // FAPI Rules.
     array(
       '#type' => 'regex',
       '#source' => 'allphp',
@@ -140,7 +140,7 @@ function coder_6x_reviews() {
       '#warning_callback' => '_coder_6x_form_set_value_warning',
       '#not' => 'array\s*\(',
     ),
-/*  from Delete API, which has been reverted
+/*  From Delete API, which has been reverted.
     array(
       '#type' => 'regex',
       '#value' => '[\s\(]confirm_form\s*\([^,]+(,\s*[^,]+){4,}',
@@ -293,7 +293,7 @@ function coder_6x_reviews() {
       '#source' => 'allphp',
       '#warning_callback' => '_coder_6x_watchdog_debug_warning',
     ),
-    // Book module rules -  start
+    // Book module rules -  start.
     array(
       '#type' => 'regex',
       '#value' => '[\s\(]book_admin_orphan\s*\(',
@@ -389,7 +389,7 @@ function coder_6x_reviews() {
       '#value' => '[\s\(]book_next\s*\(\$node',
       '#warning_callback' => '_coder_6x_book_next_warning',
     ),
-    // Book module rules -  end
+    // Book module rules -  end.
     array(
       '#type' => 'regex',
       '#value' => '\s[\'"]#value[\'"]\s*=>\s*t\s*\(\s*[\'"]Submit[\'"]\s*\)',
@@ -421,13 +421,13 @@ function coder_6x_reviews() {
 }
 
 /**
- * Define the rule callbacks for 6.x, see do_coder_review_callback()
+ * Define the rule callbacks for 6.x, see do_coder_review_callback().
  */
 function _coder_6x_callback(&$coder_args, $review, $rule, $lines, &$results) {
-  // only perform this check on module's (not includes)
+  // Only perform this check on module's (not includes).
   $filename = $coder_args['#filename'];
   if (substr($filename, -7) == '.module') {
-    // if there are any theme functions, make sure that a hook_theme exists
+    // If there are any theme functions, make sure that a hook_theme exists.
     $theme = false;
     $hook_theme = false;
     foreach ($lines as $lineno => $line) {
@@ -448,7 +448,7 @@ function _coder_6x_callback(&$coder_args, $review, $rule, $lines, &$results) {
       $results[0] = theme('coder_warning', $warning, $severity_name, $theme_lineno, $theme_line);
     }
 
-    // read the .info file
+    // Read the .info file.
     $filename = drupal_substr(realpath($filename), 0, -7) .'.info';
     if (file_exists($filename)) {
       if ($lines = file($filename)) {
@@ -473,7 +473,7 @@ function _coder_6x_callback(&$coder_args, $review, $rule, $lines, &$results) {
 }
 
 /**
- * Define the warning callbacks
+ * Define the warning callbacks.
  */
 
 function _coder_6x_new_menu_system_warning() {
index 3c01630..0fdeba3 100644 (file)
@@ -3,7 +3,7 @@
 
 /**
  * @file
- * This include file implements coder functionality for comments
+ * This include file implements coder functionality for comments.
  */
 
 /**
index 62348f8..848fcd7 100644 (file)
@@ -53,7 +53,7 @@ function coder_security_reviews() {
 
 
 /**
- * Define the rule callbacks
+ * Define the rule callbacks.
  */
 
 /* function _coder_security_callback(&$coder_args, $review, $rule, $lines, &$results) {
@@ -64,7 +64,7 @@ function coder_security_reviews() {
 } */
 
 /**
- * Define the warning callbacks
+ * Define the warning callbacks.
  */
 
 function _coder_security_l_check_plain_warning() {
index 692411a..d8d9c99 100644 (file)
@@ -3,7 +3,7 @@
 
 /**
  * @file
- * This include file implements coder functionality for Drupal Standards
+ * This include file implements coder functionality for Drupal Standards.
  */
 
 /**
@@ -101,7 +101,7 @@ function coder_style_reviews() {
     array(
       '#type' => 'regex',
       '#source' => 'html',
-      '#value' => '<'. $br .'>', // NOTE: use $br only to avoid a warning
+      '#value' => '<'. $br .'>', // NOTE: use $br only to avoid a warning.
       '#warning' => 'use &lt;br /&gt; instead of &lt;br&gt;',
       '#severity' => 'minor',
     ),
@@ -129,7 +129,7 @@ function coder_style_reviews() {
 }
 
 /**
- * Define the rule callbacks for style
+ * Define the rule callbacks for style.
  */
 function _coder_style_callback(&$coder_args, $review, $rule, $lines, &$results) {
   for ($lineno = -1; $last = array_slice($lines, $lineno); $lineno --) {
@@ -148,9 +148,9 @@ function _coder_style_core_global_regex() {
   static $coreglobalregex, $coreglobalvars;
   if (!isset($coreglobalregex)) {
     // Note: there's a little extra overhead in formatting this list as an
-    // array, but I think it makes it more readable and maintainable
+    // array, but I think it makes it more readable and maintainable.
     $coreglobalvars = array(
-      // from the Drupal 5 includes/ directory
+      // From the Drupal 5 includes/ directory.
       'active_db',
       'base_path',
       'base_root',
@@ -185,9 +185,9 @@ function _coder_style_core_global_regex() {
       'xrds_open_elements',
       'xrds_current_service',
 
-      // from the Drupal 5 modules/ directory -
+      // From the Drupal 5 modules/ directory -
       // Note: IMHO these should not be allowed, but until we fix core,
-      // other modules will need them
+      // other modules will need them.
       'channel',
       'element',
       'forum_topic_list_header',
@@ -207,7 +207,7 @@ function _coder_style_core_global_regex() {
 }
 
 /**
- * Define the warning callbacks
+ * Define the warning callbacks.
  */
 
 function _coder_style_xhtml_warning() {