I'm working on a C project that exposes a lot of global constexpr variables which form an important part of the interface. I've documented all of them like this

/** Computes the absolute value of the source values.

    Complex source values are transformed into real values. Unsigned integers remain unaltered.
 */
constexpr ExpressionChainBuilder<Abs> abs;

(see here for a bit more code context).

Now when running doxygen, a documentation for the class declared in the same source file is rendered but no documentation for that variable. I've tried out some configuration options but none of them were successful so far.

So my simple question is: How do I make those variables appear in the rendered HTML documentation?

CodePudding user response：

The Doxygen documentation seems to have example precisely for that case. You need to document \file for the document generator to have something with what to associate your global variable.