Doxygen命令@file打破了类描述部分的生成

Question

命令@file打破了doxygen生成的HTML文档中描述部分的生成。

/**
 @file Class.h

 @brief Brief desc.

 Description text.
*/

在Class.h的输出中，没有生成描述部分。因此，文本“Brief desc”和“Description text”没有显示出来。

/**
 Class.h

 @brief Brief desc.

 Description text.
*/

将按预期生成描述部分。

由于我想记录全局typdef，所以需要@file命令。

配置中是否有任何参数强制生成描述？

Answer 1

找到遗漏的信息。

通过添加@file命令 - 如文档中提到的那样http://www.doxygen.nl/manual/commands.html#cmdfile - 文档已记录在案。

这意味着doxygen将在“文件”选项卡中为该头文件创建一个额外的文档，并在通常的“类”选项卡中创建一个文档。

没有@file，只会生成“Classes”。在这种情况下（没有@file），初始注释和Objective-Cs @interface之上的注释将被解释为CLASS的组合描述。

如果存在@file命令，则初始注释将用于文件的描述 - 该文件位于“文件”选项卡中。

只有在@interface行的正上方提供注释时，才能使用该类的描述。