Follow DOXYGEN syntax for how @addtogroup is supposed to work

Created on 4 September 2015, over 9 years ago
Updated 1 March 2025, about 2 months ago

Follow-up from #2191525-29: [PP-1][policy, no patch] Extend Markdown coding standards to support API module (DOXYGEN) .

@addtogroup means "add the following things inside a @{ @} to the group/topic", so without the {} it is meaningless.

Technically speaking, the API module treats both @ingroup and @addtogroup the same (source).

The actual interpretation of the @addtogroup syntax is far different from the current DOXYGEN spec: https://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmdaddtogroup

How I read that is basically that it should behave just like if you were to use both @defgroup and @ingroup together (e.g. subtopics). This would actually eliminate the need for having to use both (which we're currently doing). That really sounds like a separate issue for the API module though. For now, I'd rather just leave it as part of this issue/proposed policy since it exists in the current grouping mechanisms already in place.

🐛 Bug report
Status

Active

Component

Documentation

Created by

🇺🇸United States markhalliwell

Live updates comments and jobs are added and updated live.
  • Coding standards

    It involves compliance with, or the content of coding standards. Requires broad community agreement.

Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Production build 0.71.5 2024