Ignore Doxygen trailing comments within function

Question

I am using ST's RFAL library which has many comments on the definitions that are trailing the value.

Example:

#define RFAL_ANALOG_CONFIG_LUT_SIZE                 (87U)     /*!< Maximum number of Configuration IDs in the Loop Up Table     */
#define RFAL_ANALOG_CONFIG_LUT_NOT_FOUND            (0xFFU)   /*!< Index value indicating no Configuration IDs found            */

#define RFAL_ANALOG_CONFIG_TBL_SIZE                 (1024U)   /*!< Maximum number of Register-Mask-Value in the Setting List    */

I am using Doxygen for code commentary and have found that this is resulting in gross behavior when referencing definitions within my code.

All of the comments with "<" preceding the line are due to be using one of RFAL's definitions within this function.

Is there any way I can ignore inner function commentary? I don't intend to ever comment my code where I expect Doxygen to parse the inside of a function. But I still want the definition comment when I look at one of RFAL's definitions in Doxygen.

Have you tried to set HIDE_IN_BODY_DOCS to YES in the Doxyfile? Other than that, have a look at the section "Configuration options related to the preprocessor". But it would be better if you could show us the piece of code (with comments and the macro usage) and the preprocessor macro definition. — Erdal Küçük
– Erdal Küçük, Commented Dec 18, 2024 at 3:03
I agree with @ErdalKüçük that a small complete example is needed. Also which version of doxygen are you using (might make a difference)? — albert
– albert, Commented Dec 19, 2024 at 14:28
@ErdalKüçük I did not have that set. That provided the desired affect. Thanks so much! — LimeSlice
– LimeSlice, Commented Dec 19, 2024 at 21:27

Erdal Küçük · Accepted Answer · 2024-12-19 21:32:38Z

1

"Is there any way I can ignore inner function commentary?"

HIDE_IN_BODY_DOCS

If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any documentation blocks found inside the body of a function. If set to NO, these blocks will be appended to the function's detailed documentation block.

The default value is: NO.

answered Dec 19, 2024 at 21:32

Erdal Küçük

6,4172 gold badges9 silver badges15 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Ignore Doxygen trailing comments within function

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related