To comply with Doxygen and comment formatting conventions with regard to the "Documenting files" section.

CommentFileSizeAuthor
#4 1394324-file-docblock-4.patch412 bytesAnonymous (not verified)
#1 1394324-file-docblock-1.patch412 bytesAnonymous (not verified)

Comments

Anonymous’s picture

Anonymous (not verified) commented
StatusFileSize
new 1394324-file-docblock-1.patch412 bytes

And here's a patch.

Anonymous’s picture

Anonymous (not verified) commented
Status: Active » Needs review

Changing status to 'needs review'.

dcrocks’s picture

dcrocks commented

Shouldn't "Seven's theme implementation" be "Seven theme's implementation"

Anonymous’s picture

Anonymous (not verified) commented
StatusFileSize
new 1394324-file-docblock-4.patch412 bytes

In looking at Bartik and Omega I assumed this was the standard format. But Zen uses the format you suggest, and it does make more sense. Here's the updated patch, but Bartik should probably also be reformatted for consistency in core themes.

dcrocks’s picture

dcrocks commented

It depends on whether the sentence says
1) (Seven)'s (theme implementation) to...
or
2) (Seven theme)'s (implementation) to...

What's the correct grammar? To me there is an implied 'The' as:
@file(This file is) The Seven theme's implementation to....

It seems that correct grammar is important in Drupal, looking at comments on other patches. I like (2) but someone else may have better justification either way.

Anonymous’s picture

Anonymous (not verified) commented

From reading here: http://api.drupal.org/api/drupal/core--modules--system--theme.api.php/gr..., it would seem that the first patch is more in line with the documentation at least. According to the docs, a "theme implementation" includes template files.

valthebald’s picture

valthebald
Location Sofia
commented
Status: Needs review » Closed (fixed)

Fixed by another issue - seven's page.tpl.php contains @file docblock