Make doxygen document the #ifdef parts too

Question

As suggested here, I have some parts in my code, that are enabled by a compilation flag.

For example I have this piece of code:

#ifdef MYPROJ_HAS_BOOST
  ...
#endif

Doxygen will leave them out, because they are omitted, since MYPROJ_HAS_BOOST is not defined. I solved it, with adding a #define MYPROJ_HAS_BOOST.

However this is not nice, because in the future (I am planning to extend the project), when the time comes to re-generate my documentation, maybe I will have forgotten about this.

Is there any way to say to Doxygen (ideally via doxywizard) to take into account these parts of my code too?

score 14 · Answer 1 · answered Sep 25 '14 at 16:07

14

In your Doxyfile (or whatever you've renamed it to) add the lines

PREDEFINED = MYPROJ_HAS_BOOST

You can also do this in doxywizard by setting the variable PREDEFINED to include MYPROJ_HAS_BOOST.

answered Sep 25 '14 at 16:07

randomusername

7,927
23
50

Didn't check it, but probably will work. However, then I may change me flag and the setting will go to waste. +1 though, since I might (for some reason which I can't think now) want to take into account only the parts with `MYPROJ_HAS_BOOST`. – gsamaras Sep 25 '14 at 16:14

score 13 · Accepted Answer · edited Mar 24 '19 at 14:51

13

I think you just need to disable preprocessing at all by setting ENABLE_PREPROCESSING to NO in doxygen configuration file.

In doxywizard go to Expert -> Preprocessor and you will find ENABLE_PREPROCESSING. Just uncheck it to set it to NO.

More information about preprocessing in doxygen can be found in documentation here.

edited Mar 24 '19 at 14:51

albert

8,285
3
19
32

answered Sep 25 '14 at 16:04

afenster

3,468
19
26

I am accepting this answer, because it's more general. – gsamaras Sep 25 '14 at 16:13
But this solution is not much convenient when we want to document the preprocessor macros. – Kozmotronik Jan 26 '23 at 15:15

score 10 · Answer 3 · edited Mar 26 '19 at 10:09

10

My understanding today is, that doxygen supports the defines. In your case you should enable

ENABLE_PREPROCESSING = YES

and set

PREDEFINED = MYPROJ_HAS_BOOST

or

PREDEFINED = MYPROJ_HAS_BOOST=1

If you want to reverse it (as you wanted it in your example) change to

PREDEFINED = MYPROJ_HAS_BOOST=0

Is is explained in more details here.

edited Mar 26 '19 at 10:09

albert

8,285
3
19
32

answered May 27 '16 at 16:25

musbach

558
1
9
29

Thanks for the answer, I didn't test it, but it seems OK. – gsamaras May 27 '16 at 18:09
This worked for me. I like it because it is precise and does not require changing the source code at all: you need only add a line to `Doxyfile.in` with the macro you wish to define; everything else is left the same. Note: this works for C as well as C++. – Liam Aug 13 '21 at 15:46

score 6 · Answer 4 · answered Sep 25 '14 at 16:11

6

Doxygen defines the macro DOXYGEN which you can use.

#if defined(MYPROJ_HAS_BOOST) || DOXYGEN
  ...
#endif

If you have many macros, it might be easier to add the Doxygen macro then to sync your macros with the one in the Doxyfile.

answered Sep 25 '14 at 16:11

usr1234567

21,601
16
108
128

1

Good for a quick solution. However, I have one macro, but in several places. +1 for the simplicity though (in the trade off of power of solution). – gsamaras Sep 25 '14 at 16:15
This did not work for me. Also, it requires changing the source code, which some may consider a negative. – Liam Aug 13 '21 at 15:47

Make doxygen document the #ifdef parts too

4 Answers4