Doxygen not generating the documentation for a function declared inside `#ifdef X` `#endif`

Question

I am making a library in C and writing internal documentation for it using Doxygen 1.9.4. I have a following header, included both from library source (in this case LIBRARY_SOURCE is defined) and from a program which is using my library:

/** @file
 *  File description... */

/** @brief Public function that is a part of an API */
void publicFunction();

#ifdef LIBRARY_SOURCE
    /** @brief Internal function that does things. */
    void internalFunction();
#endif

The problem is, Doxygen does not generate the documentation for internalFunction, but in the case ofpublicFunction everything is working as expected. Doxyfile's EXTRACT_ALL option does not help.

Why doesn't this work and how do I fix this? Thanks in advance.

Well, I couldn't find any way to do this, so I created public and private headers and it works as it should. Won't delete the question as this may help somebody — Kirill
– Kirill, Commented Jun 19, 2024 at 17:34
A bit late to the party, but in the original example where did you set the LIBRARY_SOURCE? In case in the Doxyfile did you also set MACRO_EXPANSION = YES? — albert
– albert, Commented Jul 15, 2024 at 16:56

Lex W. · Accepted Answer · 2024-06-19 07:34:14Z

1

It appears that you are not using the latest version Doxygen. If I go the Doxygen website and read the changelog, I see in version 1.10 the next line:

issue #10472: Symbols within a namespace after a heavily #ifdef class are omitted in HTML output

Could it be that this will resolve your problem?

I know that this is not a definite answer but I'm not able to post comments.

answered Jun 19, 2024 at 7:34

Lex W.

2813 silver badges12 bronze badges

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

3 Comments

Kirill Over a year ago

Thank you for an answer, but, unfortunately, the issue persists even on the latest release 1.11.0 (doxygen.nl/download.html)

Lex W. Over a year ago

I'm aware that chances are only minimal, but what if you change #ifdef in #if defined ?

Kirill Over a year ago

Nothing changed, @LexWassenberg

nx105 · Accepted Answer · 2025-04-02 13:08:51Z

0

How is LIBRARY_SOURCE defined? In the Doxygen configure file, you can set it via PREDEFINED:

PREDEFINED = LIBRARY_SOURCE

You can also check whether the documentation shows up if preprocessing is disabled (enabled by default):

ENABLE_PREPROCESSING = NO

answered Apr 2 at 13:08

nx105

1

Collectives™ on Stack Overflow

Doxygen not generating the documentation for a function declared inside `#ifdef X` `#endif`

2 Answers 2

3 Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

3 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related