Skip to content

Adhere to Drupal coding standards #139

@amcgowanca

Description

@amcgowanca

After running PHP CodeSniffer, the following errors and warnings have been reported. These must be fixed prior to next stable release.

Command:

phpcs . --standard=Drupal --ignore=modules/*,libraries/*,themes/* -v

Output:

FILE: ...agex/linux.com/dev/profiles/imagex_installkit/imagex_installkit.api.inc
--------------------------------------------------------------------------------
FOUND 3 ERROR(S) AFFECTING 3 LINE(S)
--------------------------------------------------------------------------------
  3 | ERROR | The second line in the file doc comment must be " * @file"
  4 | ERROR | The third line in the file doc comment must contain a description
    |       | and must not be indented
 70 | ERROR | Missing comment for @return statement
--------------------------------------------------------------------------------


FILE: ...ex/linux.com/dev/profiles/imagex_installkit/imagex_installkit.drush.inc
--------------------------------------------------------------------------------
FOUND 2 ERROR(S) AFFECTING 2 LINE(S)
--------------------------------------------------------------------------------
 3 | ERROR | The second line in the file doc comment must be " * @file"
 4 | ERROR | The third line in the file doc comment must contain a description
   |       | and must not be indented
--------------------------------------------------------------------------------


FILE: ...m/dev/profiles/imagex_installkit/includes/ImagexInstallKitException.inc
--------------------------------------------------------------------------------
FOUND 2 ERROR(S) AFFECTING 2 LINE(S)
--------------------------------------------------------------------------------
 3 | ERROR | The second line in the file doc comment must be " * @file"
 4 | ERROR | The third line in the file doc comment must contain a description
   |       | and must not be indented
--------------------------------------------------------------------------------


FILE: ...iles/imagex_installkit/includes/ImagexInstallKitInstallCallbackTask.inc
--------------------------------------------------------------------------------
FOUND 4 ERROR(S) AFFECTING 3 LINE(S)
--------------------------------------------------------------------------------
  3 | ERROR | The second line in the file doc comment must be " * @file"
  4 | ERROR | The third line in the file doc comment must contain a description
    |       | and must not be indented
 22 | ERROR | Function comment short description must start with a capital
    |       | letter
 22 | ERROR | Function comment short description must end with a full stop
--------------------------------------------------------------------------------


FILE: ...iles/imagex_installkit/includes/ImagexInstallKitInstallDefaultsTask.inc
--------------------------------------------------------------------------------
FOUND 5 ERROR(S) AND 1 WARNING(S) AFFECTING 5 LINE(S)
--------------------------------------------------------------------------------
  3 | ERROR   | The second line in the file doc comment must be " * @file"
  4 | ERROR   | The third line in the file doc comment must contain a
    |         | description and must not be indented
 22 | ERROR   | Function comment short description must start with a capital
    |         | letter
 22 | ERROR   | Function comment short description must end with a full stop
 67 | ERROR   | Whitespace found at end of line
 78 | WARNING | Line exceeds 80 characters; contains 83 characters
--------------------------------------------------------------------------------


FILE: ...magex_installkit/includes/ImagexInstallKitInstallFeaturesRevertTask.inc
--------------------------------------------------------------------------------
FOUND 4 ERROR(S) AFFECTING 3 LINE(S)
--------------------------------------------------------------------------------
  3 | ERROR | The second line in the file doc comment must be " * @file"
  4 | ERROR | The third line in the file doc comment must contain a description
    |       | and must not be indented
 22 | ERROR | Function comment short description must start with a capital
    |       | letter
 22 | ERROR | Function comment short description must end with a full stop
--------------------------------------------------------------------------------


FILE: ...ofiles/imagex_installkit/includes/ImagexInstallKitInstallModuleTask.inc
--------------------------------------------------------------------------------
FOUND 4 ERROR(S) AFFECTING 3 LINE(S)
--------------------------------------------------------------------------------
  3 | ERROR | The second line in the file doc comment must be " * @file"
  4 | ERROR | The third line in the file doc comment must contain a description
    |       | and must not be indented
 22 | ERROR | Function comment short description must start with a capital
    |       | letter
 22 | ERROR | Function comment short description must end with a full stop
--------------------------------------------------------------------------------


FILE: ...dev/profiles/imagex_installkit/includes/ImagexInstallKitInstallTask.inc
--------------------------------------------------------------------------------
FOUND 7 ERROR(S) AFFECTING 5 LINE(S)
--------------------------------------------------------------------------------
  3 | ERROR | The second line in the file doc comment must be " * @file"
  4 | ERROR | The third line in the file doc comment must contain a description
    |       | and must not be indented
 31 | ERROR | TRUE, FALSE and NULL must be uppercase; expected "NULL" but found
    |       | "null"
 43 | ERROR | Function comment short description must start with a capital
    |       | letter
 43 | ERROR | Function comment short description must end with a full stop
 51 | ERROR | Function comment short description must start with a capital
    |       | letter
 51 | ERROR | Function comment short description must end with a full stop
--------------------------------------------------------------------------------


FILE: ...les/imagex_installkit/includes/ImagexInstallKitInstallTaskInterface.inc
--------------------------------------------------------------------------------
FOUND 6 ERROR(S) AFFECTING 6 LINE(S)
--------------------------------------------------------------------------------
  3 | ERROR | The second line in the file doc comment must be " * @file"
  4 | ERROR | The third line in the file doc comment must contain a description
    |       | and must not be indented
 25 | ERROR | There must be an empty line before the parameter block
 28 | ERROR | @return data type must not contain "$"
 37 | ERROR | There must be an empty line before the parameter block
 40 | ERROR | @return data type must not contain "$"
--------------------------------------------------------------------------------


FILE: ...rver/imagex/linux.com/dev/profiles/imagex_installkit/includes/block.inc
--------------------------------------------------------------------------------
FOUND 3 ERROR(S) AND 1 WARNING(S) AFFECTING 4 LINE(S)
--------------------------------------------------------------------------------
  3 | ERROR   | The second line in the file doc comment must be " * @file"
  4 | ERROR   | The third line in the file doc comment must contain a
    |         | description and must not be indented
 17 | WARNING | Line exceeds 80 characters; contains 85 characters
 92 | ERROR   | If the line declaring an array spans longer than 80 characters,
    |         | each element should be broken into its own line
--------------------------------------------------------------------------------


FILE: ...er/imagex/linux.com/dev/profiles/imagex_installkit/includes/install.inc
--------------------------------------------------------------------------------
FOUND 6 ERROR(S) AND 6 WARNING(S) AFFECTING 12 LINE(S)
--------------------------------------------------------------------------------
   3 | ERROR   | The second line in the file doc comment must be " * @file"
   4 | ERROR   | The third line in the file doc comment must contain a
     |         | description and must not be indented
  26 | ERROR   | Doc comment for var tasks does not match actual variable name
     |         | $tasks at position 1
 147 | ERROR   | Missing function doc comment
 154 | ERROR   | Array indentation error, expected 4 spaces but found 2
 227 | WARNING | Line exceeds 80 characters; contains 90 characters
 243 | WARNING | Line exceeds 80 characters; contains 88 characters
 263 | WARNING | Line exceeds 80 characters; contains 84 characters
 268 | WARNING | Line exceeds 80 characters; contains 87 characters
 284 | WARNING | Line exceeds 80 characters; contains 81 characters
 296 | WARNING | Line exceeds 80 characters; contains 89 characters
 324 | ERROR   | Array indentation error, expected 6 spaces but found 4
--------------------------------------------------------------------------------

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions