c++ - Doxygen 混淆了函数文档和内部类文档

Question

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

} 

} 

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

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

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

   doSomething(int param_A 参数_B )

做某事的函数

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

这是一个内部测试类

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

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

Answer 1

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

将 doxygen 视为记录公共(public) API 的工具。如果您还想显示实现，请使用普通注释对其进行记录，并在配置文件中将 INLINE_SOURCES 设置为 YES。