評論Doxygen中的文件

Question

我有一個C頭文件，我想寫一個介紹性評論。就像這樣：

/** 
* @brief Provides stuff for my great program. 
*/ 

#ifndef MYHEADER_H 
#define MYHEADER_H 

#define __USE_GLIBC 

#endif 

而且，我有這樣的Doxyfile：

FULL_PATH_NAMES = YES 
TAB_SIZE = 8 
OPTIMIZE_OUTPUT_FOR_C = YES 
RECURSIVE = YES 
INPUT = . 
EXTRACT_ALL = YES 
QUIET = YES 
EXTRACT_STATIC = YES 

當我現在運行的Doxygen，它生成HTML和LaTeX文檔，但簡要說明結束記錄宏，而不是整個的文件。

那麼我該如何向Doxygen提供文件的簡要描述？

Answer 1

您應該使用@file宏來表示此評論相關文件作爲一個整體：

/** 
* @file myheader.h 
* @brief Provides stuff for my great program. 
*/ 

Answer 2

假設您的文件名爲header.h。這樣做：

/*! @file header.h 
* @brief Provides stuff for my great program. 
* 
* Detailed description here, if any. 
*/