Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Comment in group ignored if it does not belong to member #10764

Closed
Rubyfi opened this issue Mar 22, 2024 · 1 comment
Closed

Comment in group ignored if it does not belong to member #10764

Rubyfi opened this issue Mar 22, 2024 · 1 comment
Labels
Usage The mentioned problem is not a doxygen problem but due to usage of a feature.

Comments

@Rubyfi
Copy link

Rubyfi commented Mar 22, 2024

Describe the bug
Comments are ignored if they cannot be assigned to a member (variable, function, class, etc).

Examples:

  • does not work

    /// My Comment
    <EOF>
    
  • does work

    /// My Comment
    unit8 test = 0;
    <EOF>
    

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

    /// @addtogroup mygroup
    /// @{
    
    ...
    
    /// My Comment
    
    /// @}
    <EOF>
    
  • does work

    /// @addtogroup mygroup
    /// @{
    
    ...
    
    /// @addtogroup mygroup
    /// My Comment
    
    /// @}
    <EOF>
    
  • does work

    /// @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)
@doxygen
Copy link
Owner

doxygen commented Mar 27, 2024

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 doxygen added the Usage The mentioned problem is not a doxygen problem but due to usage of a feature. label Mar 27, 2024
@doxygen doxygen closed this as completed May 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Usage The mentioned problem is not a doxygen problem but due to usage of a feature.
Projects
None yet
Development

No branches or pull requests

2 participants