TAG = value [value, ...]及
TAG += value [value, ...]第一種形式是最常見的，也就是要設定一個TAG (也就是一個Key )，他的值為右邊所定義的部分。原則上每個值都是單一的英文字，如果您要定義的值有空白字元包含在內，可使用雙引號將它括住。如果要定義的值超過一個以上，可使用逗號","予以分隔開來。
> doxygen Doxygen
| PROJECT_NAME | Project 的名字，以一個單字為主，多個單字請使用雙引號括住。 |
| PROJECT_VERSION |
Project的版本號碼。 |
| OUTPUT_DIRECTORY |
輸出路徑。產生的文件會放在這個路徑之下。如果沒有填這個路徑，將會以目前所在路徑來作為輸出路徑。 |
| OUTPUT_LANGUAGE |
輸出語言。預設為English。1.2.16 版後，您可以使用Chinese-Traditional
來輸出中文繁體的格式。 |
| INPUT |
指定載入或找尋要處理的程式碼檔案路徑。這邊是一個表列式的型態。並且可指定檔案及路徑。舉例來說若您有a.c,
b.c, c.c 三個檔案。您可使用INPUT = a.c, b.c, c.c 的方式。若您給定一個目錄，該目錄下面所有檔案都會被處理。 |
| FILE_PATTERNS |
如果您的INPUT Tag 中指定了目錄。您可以透過這個Tag來要求Doxygen在處理時，只針對特定的檔案進行動作。例如：您希望對目錄下的副檔名為.c,
.cpp及.h的檔案作處理。您可設定FILE_PATTERNS = *.c, *.cpp, *.h。 |
| RECURSIVE |
這是一個布林值的Tag，只接受YES或NO。當設定為YES時，INPUT所指定目錄的所有子目錄都會被處理。
|
| EXCLUDE |
如果您有某幾個特定檔案或是目錄，不希望經過Doxygen處理。您可在這個Tag中指定。 |
| EXCLUDE_PATTERNS |
類似於FILE_PATTERNS的用法，只是這個Tag是供EXCLUDE所使用。 |
| SOURCE_BROWSER |
如果設定為YES，則Doxygen會產生出原始檔案的列表，以供查閱。 |
| INLINE_SOURCES |
如果設定為YES ，則程式碼也會被嵌入於說明文件中。
|
| ALPHABETICAL_INDEX |
如果設定為YES，則一個依照字母排序的列表會加入在產生的文件中。 |
| GENERATE_HTML |
若設定為YES ，就會產生HTML版本的說明文件。HTML文件是Doxygen預設產生的格式之一。
|
| HTML_OUTPUT |
HTML文件的輸出目錄。這是一個相對路徑，所以實際的路徑為OUTPUT_DIRECTORY加上HTML_OUTPUT。這個設定預設為html。
|
| HTML_FILE_EXTENSION |
HTML文件的副檔名。預設為.html。 |
| HTML_HEADER |
要使用在每一頁HTML文件中的Header。如果沒有指定，Doxygen會使用自己預設的Header。
|
| HTML_FOOTER |
要使用在每一頁HTML文件中的Footer。如果沒有指定，Doxygen會使用自己預設的Footer。
|
| HTML_STYLESHEET |
您可給定一個CSS 的設定，讓HTML的輸出結果更完美。 |
| GENERATE_HTMLHELP |
如設定為YES，Doxygen會產生一個索引檔。這個索引檔在您需要製作windows 上的HTML格式的HELP檔案時會用的上。 |
| GENERATE_TREEVIEW |
若設定為YES，Doxygen會幫您產生一個樹狀結構，在畫面左側。這個樹狀結構是以JavaScript所寫成。所以需要新版的Browser才能正確顯示。 |
| TREEVIEW_WIDTH |
用來設定樹狀結構在畫面上的寬度。 |
| GENERATE_LATEX |
設定為YES 時，會產生LaTeX 的文件。不過您的系統必需要有安裝LaTeX 的相關工具。
|
| LATEX_OUTPUT |
LaTeX文件的輸出目錄，與HTML_OUTPUT用法相同，一樣是指在OUTPUT_DIRECTORY之下的路徑。預設為latex。
|
| LATEX_CMD_NAME |
LaTeX程式的命令名稱及檔案所在。預設為latex。
|
| GENERATE_RTF |
若設定為YES ，則會產生RTF 格式的說明檔。 |
| RTF_OUTPUT |
與HTML_OUTPUT 用法相同，用來指定RTF 輸出檔案路徑。預設為rtf。 |
| GENERATE_MAN |
若設定為YES ，則會產生Unix Man Page 格式的說明文件。 |
| MAN_OUTPUT |
與HTML_OUTPUT 用法相同，用來指定Man Page的輸出目錄。預設為man。 |
| GENERATE_XML |
若設定為YES ，則會產生XML 格式的說明文件。 |
| ENABLE_PREPROCESSING |
若設定為YES ，則Doxygen 會啟動C 的前置處理器來處理原始檔。
|
| PREDEFINED |
可以讓您自行定義一些巨集。類似於gcc 中的-D選項。 |
/**
* ... 註解 ...
*/
/*!
* ... 註解 ...
*/
/// ... 註解 ...或
//! ... 註解 ...
/*!< ... 註解 ... */
/**< ... 註解 ... */
//!< ... 註解 ...
///< ... 註解 ...
class MyClass {
public:
int member1 ;
int member2:
void member_function();
}; /**
* 我的自訂類別說明 ...
*/
class MyClass {
public:
int member1 ; ///< 第一個member說明 ...
int member2: ///< 第二個member說明 ...
int member_function(int a, int b);
};
/**
* 自訂類別的member_funtion說明 ...
*
* @param a 參數a的說明
* @param b 參數b的說明
*
* @return 傳回a+b。
*/
int MyClass::member_function( int a, int b )
{
return a+b ;
} /**
* class或function的簡易說明...
*
* class或function的詳細說明...
* ...
*/ /**
* @brief class或function的簡易說明...
*
* class或function的詳細說明...
* ...
*/
/*! \file myfile.h
\brief 檔案簡易說明
詳細說明.
\author 作者資訊
*/| @file |
檔案的註解說明。 |
| @author |
作者的資訊 |
| @brief |
用於class 或function的註解中，後面為class 或function的簡易說明。 |
| @param |
格式為@param arg_name 參數說明主要用於函式說明中，後面接參數的名字，然後再接關於該參數的說明。 |
| @return |
後面接函數傳回值的說明。用於function的註解中。說明該函數的傳回值。 |
| @retval |
格式為@retval value 傳回值說明主要用於函式說明中，說明特定傳回值的意義。所以後面要先接一個傳回值。然後在放該傳回值的說明。 |
/**
* @file 本範例的include檔案。
*
* 這個檔案只定義example這個class。
*
* @author garylee@localhost
*/
#define EXAMPLE_OK 0 ///< 定義EXAMPLE_OK的巨集為0。
/**
* @brief Example class的簡易說明
*
* 本範例說明Example class。
* 這是一個極為簡單的範例。
*
*/
class Example {
private:
int var1 ; ///< 這是一個private的變數
public:
int var2 ; ///< 這是一個public的變數成員。
int var3 ; ///< 這是另一個public的變數成員。
void ExFunc1(void);
int ExFunc2(int a, char b);
char *ExFunc3(char *c) ;
}; /**
* @file 本範例的程式碼檔案。
*
* 這個檔案用來定義example這個class的
* member function。
*
* @author garylee@localhost
*/
/**
* @brief ExFunc1的簡易說明
*
* ExFunc1沒有任何參數及傳回值。
*/
void Example::ExFunc1(void)
{
// empty funcion.
}
/**
* @brief ExFunc2的簡易說明
*
* ExFunc3()傳回兩個參數相加的值。
*
* @param a 用來相加的參數。
* @param b 用來相加的參數。
* @return 傳回兩個參數相加的結果。
*/
int ExFunc2(int a, char b)
{
return (a+b);
}
/**
* @brief ExFunc3的簡易說明
*
* ExFunc3()只傳回參數輸入的指標。
*
* @param c 傳進的字元指標。
* @retval NULL 空字串。
* @retval !NULL 非空字串。
*/
char * ExFunc2(char * c)
{
return c;
} > doxygen Doxygen