c++ - Doxygen 没有为函数添加文档

Question

Doxygen 没有在这个类中添加我的任何成员函数的文档:

#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_ */

即使我将 EXTRACT_ALL 设置为 YES，它也能很好地生成类文档，但不会生成函数文档。你知道为什么会这样吗？

Answer 1

该函数是私有(private)的，除非另外声明为 public 或 protected。

默认情况下，doxygen 排除私有(private)函数，即使设置 EXTRACT_ALL 为真。您可以通过将它们添加到 Doxyfile EXTRACT_PRIVATE = YES 来包含它们。

引自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.