氧混淆了函数文档和内部类文档

Doxygen confused between documentation of function and inner class

本文关键字：文档 内部类 函数      更新时间：2023-10-16

氧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 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) { 
} 
}

当我为上面的类生成氧文档时，在函数doSomething和内部类InnerTestClass的文档之间发生了混淆。

    没有创建名为classInnerTestClass.html的内部类文档文件。

  1. 在classstestclass .html的文档中，InnerTestClass的文档包含在函数的文档中，如下所示:

    doSomething (int param_Aint param_B)

做某事的函数

参数param_A这是doSomething函数的第一个参数param_B这是doSomething函数的第二个参数

这是一个内部测试类

参数param_C这是InnerTestClass内部类构造函数的参数

  • 显示警告消息，指示param_A和param_B没有记录，并且在doSomething的参数列表中没有找到param_C。

    • 在函数/方法内部定义的结构/类被认为是实现细节，不能被记录(就像你不能记录单个for循环或if语句一样)。

    把氧看作是记录公共 API的工具。如果你还想显示实现，用正常的注释记录它，并在配置文件中将INLINE_SOURCES设置为YES。

    相关文章：