Doxygen命令@file打斷生成類描述部分

Question

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

/** 
@file Class.h 

@brief Brief desc. 

Description text. 
*/ 

在Class.h的輸出中沒有生成描述部分。因此文本「Brief desc」和「描述文本」沒有出現。

/** 
Class.h 

@brief Brief desc. 

Description text. 
*/ 

將按預期生成描述部分。

因爲我想記錄全局typdefs @file命令是必要的。

配置中是否有任何參數強制生成Description？

Answer 1

找到缺少的信息。

通過添加@file命令 - 如文檔中提到http://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmdfile - FILE被記錄。

這意味着doxygen將在「文件」選項卡中爲該頭文件創建一個額外的文檔，並在通常的「類」選項卡中爲該文件創建一個額外的文檔。

沒有@file只會在「類」中生成。在這種情況下（沒有@file）初始註釋和Objective-Cs @interface之上的將被解釋爲CLASS的組合描述。

如果存在@file命令，則初始註釋將用於位於「文件」（Files）選項卡中的文件描述。

僅當您在@interface行上方提供註釋時才能使用此類的說明。