C++ private class member variables don't appear in the documentation

c++ doxygen
notnull picture notnull · Feb 1, 2015 · Viewed 17.5k times · Source

Class is documented as follows:

/**
 * @brief   Number representation
 */
class CNumber : public CElem
{
  /** @brief Holds true for negative values */
  bool    neg;
  ...

However, the variable documented in the code doesn't appear in the documentation (class brief shows fine...).

What am I doing wrong?

Answer

rightfold picture rightfold · Feb 1, 2015

It's private. Make it public or protected and it will show up, or configure Doxygen to show private members by setting the EXTRACT_PRIVATE tag to YES in the configuration file (which is usually "Doxyfile").

Related questions

How to use doxygen to create UML class diagrams from C++ source

I have been searching for some material that describes how to generate simple class diagrams with doxygen, but couldn't find one. Can anybody help? I need to create diagrams as shown below from a set of C++ files. If there …

Read More
Documenting enum values with doxygen

Given: namespace Foo { class Foo { public: /// Foo enum, possible ways to foo enum class Foo { /// Foo it with an A A, /// Foo it with a B B, /// Foo it with a C C } } } And the default Doxyfile made with doxygen …

Read More
A doxygen eclipse plugIn automatically generating stub documentation?

I'am looking for an eclipse-plugin for doxygen code documentation. I have found the eclox-plugIn ( http://home.gna.org/eclox/ ). I would like find out, how can it automatically generate a "empty" doxygen comment, which could be filled out later or …

Read More