"End of foo group" on a couple of API pages due to not following standards

Have you tested this proposed fix with the API module yet? And just curious, what was your first suggestion that didn't work?

Maybe we should just fix this in the API module anyway rather than changing the standard?

(This issue is similar to #1358944: Misused @ingroup commands, although that other issue doesn't address core/includes/actions.inc)

What I see is that actions.inc is not following the rules - I don't think the rules need to be changed.

When a doc block is just defining a group, then the example given in our documentation standards for defgroups says to do this:

Here is the basic syntax for defining a group:

/**
 * @defgroup group_identifier Name of the group for Topics page
 * @{
 * One line, one sentence description of the topic/group.
 *
 * One or more additional paragraphs of information, which will appear
 * on the topic page.
 * @}
 */

Note there is no recommendation to add "End of" after the @}, because when @{ and @} are in the same block "End of" is unneeded.

What actions.inc does is to add additional text after that @}. Any text in the doc block that's not part of a doxygen tag will properly show up in the API docs. There is no reason to add 'End of "defgroup actions"' here!

An alternative way of defining groups is also spelled out in our documentation standards for defgroups:

If you put the group definition immediately before one or more functions that belong in the group, you can automatically add functions to the group by using this syntax:

/**
 * @defgroup group_identifier Name of the group for Topics page
 * @{
 * One line, one sentence description of the topic/group.
 *
 * One or more additional paragraphs of information, which will appear
 * on the topic page.
 */

// Functions here are automatically added to the group.

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

Note that here the "End of" comment *is* needed, because there's a large gap between the doc block containing the @{ and the SEPARATE doc block whose sole purpose is to hold the @} tag. The block with the end tag is not commenting any function, so any text in this block never shows up in the API docs.

action.inc is mixing the two styles. It needs to choose one or the other. core/includes/form.inc makes the same mistake - all the other core/includes/*.inc files do the right thing. Attached is a patch to fix both actions.inc and form.inc. But perhaps this fix should be part of #1358944: Misused @ingroup commands ?

This fix looks fine, and should fix the issue. Glad the standards are fine as they are. :)

Here's the same patch for D7.

Fixing issue title to reflect what the problem actually is.

Committed to 7.x. I believe this was already committed to 8.x. Marking as 'fixed'. Thanks for continuously making our documentation better!

Thanks! It does indeed look like it is fixed in 8.x also.

I'm not sure whether sufficient research went into this issue.

As far as I can look back in my PHP dev, I've always seen and used this syntax (also prior to Drupal).

oh, I'm mistaken. You only removed it from blocks that opened a section in the very same block.

That's fine.