You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
/// @addtogroup mygroup
/// @{
...
/// My Comment
unit8 test = 0;
/// @}
<EOF>
To Reproduce doxygen_demo.zip
In the generated output, the ignored comments only show up in the source html.
The working comments show up in the file/group documentation as well.
Expected behavior
The currently ignored comments should be assigned to the file documentation or the group documentation respectively.
Version
1.9.6 (Windows 10, 64bit)
1.10.0 (Windows 10, 64bit)
The text was updated successfully, but these errors were encountered:
Expected behavior
The currently ignored comments should be assigned to the file documentation or the group documentation respectively.
File documentation requires the use of @file command and group documentation requires either a @addgroup to add documentation to an existing group, or a documented group member (like an int or class) with documentation. Otherwise the documentation is indeed not attached to anything and ignored.
So I think the problem is usage.
doxygen
added
the
Usage
The mentioned problem is not a doxygen problem but due to usage of a feature.
label
Mar 27, 2024
Describe the bug
Comments are ignored if they cannot be assigned to a member (variable, function, class, etc).
Examples:
does not work
does work
This is even the case, if the comment is nested in an
addtogroup
scope.In this case, you have to explicitly mark the block again.
Examples:
does not work
does work
does work
To Reproduce
doxygen_demo.zip
In the generated output, the ignored comments only show up in the source html.
The working comments show up in the file/group documentation as well.
Expected behavior
The currently ignored comments should be assigned to the file documentation or the group documentation respectively.
Version
The text was updated successfully, but these errors were encountered: