I have a C header for which I want to write an introductory comment. Like this:
/** * @brief Provides stuff for my great program. */ #ifndef MYHEADER_H #define MYHEADER_H #define __USE_GLIBC #endif
Furthermore, I have this Doxyfile:
FULL_PATH_NAMES = YES TAB_SIZE = 8 OPTIMIZE_OUTPUT_FOR_C = YES RECURSIVE = YES INPUT = . EXTRACT_ALL = YES QUIET = YES EXTRACT_STATIC = YES
When I run Doxygen now, it generates HTML and LaTeX documentation, but the brief description ends up documenting the macro instead of the whole file.
So how can I provide Doxygen with a brief description of the file?