Doxygen not adding documentation for a function

Question

Doxygen is not adding the documentation of any of my member functions in this class:

#ifndef SET_H_
#define SET_H_

/** @file */

/**
 * A mathematical set
 */
class Set
{
    virtual ~Set();

    /**
     * The countability of this set
     * @returns Whether this set is a countable one or not.
     */
    virtual bool isCountable();

    ...
}

#endif /* SET_H_ */

It produces the class documentation just fine, but not the function documentation even if I set EXTRACT_ALL to YES. Do you know why this is the case?

albert · Accepted Answer · 2018-12-16 17:56:23Z

5

The function is private unless declared otherwise as public or protected.

By default, doxygen excludes private functions, even when setting EXTRACT_ALL is true. You can include them by adding to the Doxyfile EXTRACT_PRIVATE = YES.

Quoting from Doxygen's FAQ:

Is your class / file / namespace documented? If not, it will not be extracted from the sources unless EXTRACT_ALL is set to YES in the config file.

Are the members private? If so, you must set EXTRACT_PRIVATE to YES to make them appear in the documentation.

edited Dec 16, 2018 at 17:56

albert

9,2103 gold badges24 silver badges42 bronze badges

answered Mar 17, 2015 at 10:37

usr1234567

23.8k20 gold badges125 silver badges141 bronze badges

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

Collectives™ on Stack Overflow

Doxygen not adding documentation for a function

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related