How can I keep doxygen from documenting #defines in a C file?

Posted by Chris Nelson on Stack Overflow See other posts from Stack Overflow or by Chris Nelson
Published on 2009-11-04T16:40:45Z Indexed on 2010/03/14 20:15 UTC
Read the original article Hit count: 196

Filed under:

I have #define values in headers that I certainly want Doxygen to document but I have others in C files that I treat as static constants and I don't want Doxygen to document them. Something as simple and stupid as

#define NUMBER_OF(a) (sizeof((a))/sizeof((a)[0]))
#define MSTR(e) #e

How can I keep Doxygen from putting those #defines in the documentation it creates? I've tried marking it with @internal but that didn't seem to help.

A somewhat-related question on Doxygen and #define, how can I get:

#define SOME_CONSTANT 1234 /**< An explanation */

to put "SOME_CONSTANT" and "An explanation" but not "1234" in the output?

Related posts about doxygen

Exclude some classes from doxygen documentation

as seen on Stack Overflow - Search for 'Stack Overflow'
I am building a Qt based project, and many Qt classes are found in the target documentation. How can I tell Doxygen to disable documentation generation for some classes? For Q.*? >>> More
Doxygen C++ comment string parser in python?

as seen on Stack Overflow - Search for 'Stack Overflow'
Does anybody know of a python module to parse a doxygen style C++ comment string? I mean a string like this (simple example): /** * A constructor. * A more elaborate description of the constructor. * @param param1 test1 * @param param2 test2 */ and I would like to extract the brief… >>> More
Customizing doxygen output for the HTML Table of Contents

as seen on Stack Overflow - Search for 'Stack Overflow'
I'm using doxygen to generate an API reference from source code, aiming to convert it into a CHM help file and eventually into a plugin for Eclipse. Unfortunately the default ordering and nesting of the classes, namespaces, etc. in the Table of Contents is not exactly ideal and I'd prefer to customize… >>> More
Is there any way to integrate doxygen with svn

as seen on Stack Overflow - Search for 'Stack Overflow'
Is there any way to configure doxygen to include the log from svn for a file as part of the output. Basically we enter pretty rigorous log messages into svn when we do commits, and I'd like those messages to have a section inside the doxygen output. >>> More
GNU autoconf, document options using doxygen?

as seen on Stack Overflow - Search for 'Stack Overflow'
hi Is it possible to document configure.ac such that doxygen can pick up embedded comments and produce documentation for options, variables, etc. in generated manuals? Thanks >>> More

Developer IT

How can I keep doxygen from documenting #defines in a C file? - Developer IT

How can I keep doxygen from documenting #defines in a C file?

doxygen

c

define

Related posts about doxygen

Exclude some classes from doxygen documentation

Doxygen C++ comment string parser in python?

Customizing doxygen output for the HTML Table of Contents

Is there any way to integrate doxygen with svn

GNU autoconf, document options using doxygen?

Related posts about c

Categories cloud