Home > Mobile >  Doxygen typedef struct
Doxygen typedef struct

Time:07-19

I've got the problem that doxygen will auto document all typedef structs from header files which are included in the configurations. They are listed as "Data structures" in the HTML documentation on the sidebar. Which option is needed to deactivate the auto documentation from structs? Thanks!

CodePudding user response:

Since your struct definiton goes in the header file doxygen will document it automatically unless you define your structure in related C file; in this case it'd be private and cold be prevented to output by setting the EXTRACT_ALL, EXTRACT_PRIVATE and EXTRACT_STATIC options to NO.
But since the definition resides in your header file you can hide it either by setting the EXCLUDE_SYMBOLS to your struct symbol/definiton name(s) or as an alternative to the EXCLUDE_SYMBOLS option you can use hideinitializer command in the comment section of your struct type in source code.

  • Related