At the end of the PHP Wrapper Functions topic page, this text appears:

End of "defgroup php_wrappers".

It should be removed.

http://api.drupal.org/api/drupal/includes--common.inc/group/php_wrappers/7

Good project for a novice doc contributor...

CommentFileSizeAuthor
#1 987232.patch462 bytesjhodgdon

Comments

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Active » Needs review
Issue tags: -Novice
StatusFileSize
new 987232.patch462 bytes

This should take care of it.

mr.baileys’s picture

mr.baileys
Primary language Dutch
Location 🇧🇪 (Ghent)
commented
Status: Needs review » Needs work

Actually, the Doxygen guidelines on grouping include this text with the @}-directive, and most of the core groups also have the "End of ..."-portion included.

I think in this case it's caused by lumping the @} in with an existing block instead of making it a separate comment block:

/**
 * @} End of "defgroup php_wrappers".
 */

Which means we should probably clarify the above guidelines to say that the start- and end-group declarations need to be stand-alone comment blocks and not part of an existing comment block.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Needs work » Needs review

I don't think we need an "End of xyz" comment if it's all in the same docblock, so I'll remove that from the guidelines.

I also think the patch is OK, and that this is a rare case. Normally we define a group in the place where there are functions, so the end of the defgroup is a ways down in the file.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

I fixed up the doxygen standards page. It turned out we had two sections on that page about defgroup. Now we have one, and I think it's all corrected. :)

mr.baileys’s picture

mr.baileys
Primary language Dutch
Location 🇧🇪 (Ghent)
commented
Status: Needs review » Reviewed & tested by the community

You're right -- I compared the patch with other occurences of @} in core but failed to notice that in this case the group was declared and closed within the same comment block.

I agree that the current patch is good to go, thanks for fixing the doxygen standards page!

webchick’s picture

webchick
she/they
Primary language English
Location Vancouver 🇨🇦
commented
Status: Reviewed & tested by the community » Fixed

Committed to HEAD. Thanks!

Status: Fixed » Closed (fixed)

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