Found a list of coding standards issues in template.php while making another patch.

I've made a patch that alleviates these errors, though they should be reviewed to make sure all of the comments are accurate and necessary.

--------------------------------------------------------------------------------
FOUND 22 ERROR(S) AND 4 WARNING(S) AFFECTING 19 LINE(S)
--------------------------------------------------------------------------------
    4 | ERROR   | The third line in the file doc comment must contain a
      |         | description and must not be indented
   76 | ERROR   | Missing function doc comment
  156 | ERROR   | Doc comment for var An does not match actual variable name
      |         | $links at position 1
  156 | ERROR   | Parameter comment must be on the next line at position 1
  178 | ERROR   | Doc comment for var An does not match actual variable name
      |         | $link at position 1
  178 | ERROR   | Parameter comment must be on the next line at position 1
  255 | ERROR   | Missing function doc comment
  401 | ERROR   | Inline comments must end in full-stops, exclamation marks, or
      |         | question marks
  412 | WARNING | Line exceeds 80 characters; contains 125 characters
  412 | ERROR   | Comment indentation error, expected only 1 spaces
  441 | ERROR   | Case breaking statements must be followed by a single blank
      |         | line
  883 | ERROR   | Function comment short description must be on a single line,
      |         | further text should be a separate paragraph
  888 | ERROR   | Last parameter comment requires a blank newline after it
  888 | ERROR   | Doc comment for var A does not match actual variable name
      |         | $reveal at position 1
  888 | ERROR   | Parameter comment must be on the next line at position 1
 1215 | WARNING | Line exceeds 80 characters; contains 97 characters
 1217 | ERROR   | Doc comment for var [ UNKNOWN ] does not match actual
      |         | variable name $variables at position 1
 1217 | ERROR   | Missing parameter name at position 1
 1217 | ERROR   | Missing comment for param "[ UNKNOWN ]" at position 1
 1219 | ERROR   | Missing comment for @return statement
 1253 | ERROR   | Missing parameter type at position 1
 1263 | ERROR   | Return comment must be on the next line
 1265 | WARNING | Line exceeds 80 characters; contains 101 characters
 1292 | ERROR   | Missing parameter type at position 1
 1300 | ERROR   | Return comment must be on the next line
 1302 | WARNING | Line exceeds 80 characters; contains 95 characters
--------------------------------------------------------------------------------
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

FiLeVeR10’s picture

Version: 8.x-5.x-dev » 7.x-5.x-dev
FiLeVeR10’s picture

Status: Active » Needs review
chrisjlee’s picture

Status: Needs review » Reviewed & tested by the community

Looks good to me.

FiLeVeR10’s picture

Status: Reviewed & tested by the community » Fixed

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.