Doxygen不添加函数的文档

时间:2015-03-17 10:23:52

标签: c++ doxygen

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,它也能很好地生成类文档,但不能生成函数文档。你知道为什么会这样吗?

1 个答案:

答案 0 :(得分:2)

除非另有说明为publicprotected,否则该函数是私有的。

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

引自Doxygen's FAQ

  

您的类/文件/命名空间是否已记录?如果没有,它就不会   从源中提取,除非EXTRACT_ALL设置为YES   配置文件。

     

会员是否私密?如果是这样,你必须设置   EXTRACT_PRIVATE为YES以使它们出现在文档中。