Can doxygen include the documentation of a macro in a class documentation?

Asked Jun 22 '17 at 15:58

Active Jun 22 '17 at 15:58

Viewed 209 times

I have code that looks more or less like this:

// foo.h

/**
 * Lalala blablabla
 */
#define Foo_X Foo::doSomething(1)

/**
 * Fofofoo
 */
class Foo {
public:
    static doSomething(int x);
};

This will make the documentation of the macro appear in the documentation of the file. However, if possible I would like to have it included in the class documentation of Foo. Is this possible?

I found this related question, but if possible I dont want to link the macro documentation, but include the documentation of the macro itself in the class doc.

PS: I know that for this simplified example it doesnt make much sense to use a macro. In the real code I do need the macro and users typically wont ever call doSomething directly, but only through the macro.

asked Jun 22 '17 at 15:58

463035818_is_not_an_ai

109,796
11
89
185

why using macros at all? – The Techel Jun 22 '17 at 16:02
@TheTechel read the end of the question – Arnav Borborah Jun 22 '17 at 17:03
yeah, I did. Why using a macro for that? – The Techel Jun 22 '17 at 17:06
@TheTechel this is a simplified example for which I would never use a macro. However, for the real code (that is too long and too irrelevant to show here) I do need the macro. Anyhow just assume there is a macro, how can it be documented in the class documentation? – 463035818_is_not_an_ai Jun 23 '17 at 11:07

Can doxygen include the documentation of a macro in a class documentation?

0 Answers0