2013-12-11 116 views
1

我在源代碼中包含一些我想添加一些「待辦事項」的內容。如何用Doxygen文件包含文件包括

例如:

/** \todo Review. */ 
#include "anyfile.h" 

/** todo Another to do. */ 
#define ANY_MACRO 1 

的問題是,第一個「做」插入宏定義,而不是在包括如下:

----------------------------------- 
**Todo List** 

Global **ANY_MACRO** 

Review. 

Another to do. 

----------------------------------- 

任何想法如何解決這個?

回答

0

online doc

讓我們重複一下,因爲它常常被忽略:記錄全局對象(函數,類型定義,枚舉,宏等等),你必須證明它們所定義的文件。

然後我處理以下方式你的問題:我必須在這兩個文件\file評論,在包括線以上,我提的是,待辦事項部分是指包含的文件。

換句話說,我寫這在我的源文件afile.c:

/** \file anyfile.h 
* \todo Review 
*/ 
#include "anyfile.h" 

/** \file afile.c 
* \brief Some code 
*/ 

/** \todo wait, a todo !*/ 
#define A_MACRO 

int main() 
{} 

在所包含的文件,我寫有關文件本身就是一個簡短的註釋:

/** \file anyfile.h 
* Very interesting header 
*/ 

#define B_MACRO 

作爲輸出,待辦事項評論被放置在包含文件的文檔頁面中。根據我的尷尬的一部分是,我必須將/** \file afile.c */塊放在include行之後,否則它不起作用。