C++ Doxygen混淆了函数和内部类的文档
强氧1.8.10 在一个类中,我有一个函数,其中声明了一个内部类C++ Doxygen混淆了函数和内部类的文档,c++,function,doxygen,inner-classes,C++,Function,Doxygen,Inner Classes,强氧1.8.10 在一个类中,我有一个函数,其中声明了一个内部类 /*! This is a test class */ class TestClass { /*! \brief A function which does something * \param param_A this is the first parameter of doSomething function * \param param_B this is the second parameter of
/*! This is a test class
*/
class TestClass {
/*! \brief A function which does something
* \param param_A this is the first parameter of doSomething function
* \param param_B this is the second parameter of doSomething function
*/
void doSomething(int param_A, int param_B) {
/*! This is an inner Test Class
*/
class InnerTestClass {
/*! \brief A constructor for InnerTestClass
* \param param_C this is the parameter for the InnerTestClass inner class constructor
*/
InnerTestClass (int param_C) {
}
}
当我为上述类生成doxygen文档时,函数doSomething的文档和内部类InnerTestClass的文档之间会出现混淆
在函数/方法中定义的结构/类被视为实现细节,不能被记录(就像不能记录单个for循环或if语句一样)
将doxygen作为记录公共API的工具。如果您还想显示实现,请使用普通注释对其进行记录,并在配置文件中将
INLINE_SOURCES
设置为YES
。代码中缺少结束括号,您应该首先更正它。另请参阅Bug 754818-Doxygen混淆了函数和内部类的记录()