Documenting preprocessor options with Doxygen

Question

I have a C++ package that allows for different behavior if the user defines different pre-processor constants. For example, a user can use /D ALLOW_WIDE_CHAR in the makefile to change the behavior to support wide characters.

I would like to document these options with Doxygen, but Doxygen complains because there is no actual #define in the code. It is up to the user to do that.

Adding the definition to the PREDEFINED list in the configuration file doesn't help.

Suggestions?

mek363 · Accepted Answer · 2014-01-25 16:42:23Z

2

One option I found is to create an extra source file, say Doxygen.h, that is not compiled, but is added to the Doxygen file list. This file can use #define to define those pre-processor constants. It seems like there should be a better solution, though.

answered Jan 25, 2014 at 16:42

mek363

4151 gold badge5 silver badges13 bronze badges

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

1 Comment

DavidZemon Over a year ago

This is the best option I've seen so far, but definitely still not ideal :(

Collectives™ on Stack Overflow

Documenting preprocessor options with Doxygen

1 Answer 1

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related