1

命令 @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 命令是必要的。

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

4

1 回答 1

1

找到丢失的信息。

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

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

如果没有@file,只会生成“类”中的文件。在这种情况下(没有 @file),初始注释和 Objective-Cs @interface 上方的注释将被解释为 CLASS 的组合描述。

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

仅当您直接在 @interface 行上方提供注释时,该类的描述才可用。

于 2013-02-25T13:26:14.077 回答