Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How to exclude undocumented member functions/variables of a class from doxygen output? [duplicate]

Tags:

c++

doxygen

As the title suggests, is this possible?

Basically, anything undocumented, to not appear in the output.

like image 535
themagicalyang Avatar asked Oct 19 '25 01:10

themagicalyang


1 Answers

I usually export only the necessary, so: (no static and private as well)

# do not extract all
EXTRACT_ALL            = NO
EXTRACT_PRIVATE        = NO
EXTRACT_STATIC         = NO

And also hide the uncommented stuff:

# hide undoc stuff
HIDE_UNDOC_MEMBERS     = YES
HIDE_UNDOC_CLASSES     = YES
HIDE_FRIEND_COMPOUNDS  = YES
HIDE_IN_BODY_DOCS      = YES

After you did this, only files in which you used the @file tag will be processed, and only the documented elements will be considered.

(doxygen 1.8.13)

like image 152
Marty Sama Avatar answered Oct 21 '25 13:10

Marty Sama



Donate For Us

If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!