As reported by dman in http://drupal.org/node/212400#comment-700739, some core files are missing @file blocks. This is required for API module to read meaningful information in the file listing at http://api.drupal.org/api/files. It's also just plain a good practice, so people can tell at a glance what the file contains.

Coder should be checking for this, and raising a flag if it's not present. The format should go:

<?php
// $Id$

/**
 * @file
 * A one-line description of the file.
 *
 * Optionally, more description of the file here. Blah blah blah, describe
 * describe, describe...
 */
...
CommentFileSizeAuthor
#5 coder_212804.patch1.95 KBstella
#3 coder_212804.patch1.48 KBstella

Comments

stella’s picture

I don't think there's any way at present to check for the format you gave. However, I can add a check to see if there is a @file and if so, if it is followed by any text. I'm pretty sure coder is only able to analyse one line at a time and not in relation to the surrounding lines.

Cheers,
Stella

webchick’s picture

Aw, shucks. :(

Well checking for @file would be a good start!

stella’s picture

Status: Active » Needs review
StatusFileSize
new1.48 KB

Try out the attached patch.

Cheers,
Stella

webchick’s picture

Status: Needs review » Needs work

Cool. This successfully yelled at me about not having a @file block in bio.module. :)

However, the warning is fairly terse. Could we also link to http://drupal.org/node/1354#files for more info?

stella’s picture

Status: Needs work » Needs review
StatusFileSize
new1.95 KB

Updated patch attached.

Cheers,
Stella

stella’s picture

Status: Needs review » Fixed

Committed.

Anonymous’s picture

Status: Fixed » Closed (fixed)

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