Early Bird Registration for DrupalCon Portland 2024 is open! Register by 23:59 PST on 31 March 2024, to get $100 off your ticket.
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...
Comment | File | Size | Author |
---|---|---|---|
#1 | 987232.patch | 462 bytes | jhodgdon |
Comments
Comment #1
jhodgdonThis should take care of it.
Comment #2
mr.baileysActually, 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: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.
Comment #3
jhodgdonI 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.
Comment #4
jhodgdonI 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. :)
Comment #5
mr.baileysYou'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!
Comment #6
webchickCommitted to HEAD. Thanks!