組態設定

格式

組態檔案是一個自由格式的 ASCII 文字檔案,其結構類似於 Makefile,預設名稱為 Doxyfile。它由 doxygen 解析。該檔案可能包含用於格式化的 Tab 字元和換行符號。檔案中的語句會區分大小寫。

組態檔案基本上由一組指派語句組成。每個語句都由一個以大寫字母寫成的 TAG_NAME 組成,後面跟著等號 (=) 和一個或多個值。如果同一個標籤被指派多次,則最後一次指派會覆寫任何先前的指派。對於將列表作為引數的標籤,可以使用 += 運算子來代替 =,將新值附加到列表中。值是不包含空格的字元序列。如果值應包含一個或多個空格,則必須用引號 ("...") 括住。可以透過在行的最後一個非空白字元處插入反斜線 (\) 來串聯多行。

註解以井號 (#) 字元開頭,並在行尾結束。註解可以放置在檔案中的任何位置(引號內除外)。以兩個井號字元 (##) 開頭的註解會在更新組態檔案時保留,前提是它們放置在 TAG_NAME 前面,或放置在組態檔案的開頭或結尾。

可以使用 $(ENV_VARIABLE_NAME) 模式來展開環境變數。一個小例子:

DOT_PATH      = $(YOUR_DOT_PATH)

您也可以使用 @INCLUDE 標籤從另一個組態檔案中包含一部分組態檔案,如下所示:

@INCLUDE = config_file_name

包含檔案會在目前的工作目錄中搜尋。您也可以指定在搜尋目前工作目錄之前應搜尋的目錄清單。請在 @INCLUDE 標籤之前放置帶有這些路徑的 @INCLUDE_PATH 標籤,例如:

@INCLUDE_PATH = my_config_dir

組態選項可以分為幾個類別。以下是已識別標籤的字母順序索引,後面是按類別分組的標籤描述。

專案相關的組態選項

DOXYFILE_ENCODING

此標籤指定組態檔案中所有後續字元使用的編碼。預設值為 UTF-8,這也是此標籤第一次出現之前所有文字使用的編碼。Doxygen 使用 libiconv(或內建於 libc 的 iconv)進行轉碼。請參閱 https://gnu.dev.org.tw/software/libiconv/ 以取得可能的編碼清單。

預設值為:UTF-8

PROJECT_NAME

PROJECT_NAME 標籤是一個單字(或用雙引號括住的單字序列,除非您使用的是 Doxywizard),它應識別要為其產生文件的專案。此名稱會用於大多數產生頁面的標題以及其他幾個位置。

預設值為:My Project

PROJECT_NUMBER

PROJECT_NUMBER 標籤可用於輸入專案或修訂版本號碼。這對於封存產生的文件或如果使用某些版本控制系統可能會很方便。

PROJECT_BRIEF

使用 PROJECT_BRIEF 標籤,可以為專案提供一個可選的單行描述,該描述會顯示在每個頁面的頂部,並應讓檢視者快速了解專案的目的。請保持描述簡短。

PROJECT_LOGO

使用 PROJECT_LOGO 標籤,可以指定文件中包含的標誌或圖示。標誌的最大高度不應超過 55 像素,最大寬度不應超過 200 像素。Doxygen 會將標誌複製到輸出目錄。

PROJECT_ICON

使用 PROJECT_ICON 標籤,可以指定 HTML 文件顯示時包含在索引標籤中的圖示。Doxygen 會將標誌複製到輸出目錄。

OUTPUT_DIRECTORY

OUTPUT_DIRECTORY 標籤用於指定將產生文件寫入的 (相對或絕對) 路徑。如果輸入相對路徑,則它將相對於啟動 Doxygen 的位置。如果留空,則將使用目前目錄。

CREATE_SUBDIRS

如果 CREATE_SUBDIRS 標籤設定為 YES,則 Doxygen 會在每個輸出格式的輸出目錄下建立最多 4096 個子目錄(分為 2 個層級),並將產生的檔案分散在這些目錄中。當 Doxygen 處理大量原始碼檔案時,啟用此選項會很有用,因為若將所有產生的檔案放在同一個目錄中,可能會導致檔案系統效能問題。調整 CREATE_SUBDIRS_LEVEL 來控制子目錄的數量。

預設值為:NO

CREATE_SUBDIRS_LEVEL

控制當 CREATE_SUBDIRS 標籤設定為 YES 時將建立的子目錄數量。層級 0 代表 16 個目錄,而每增加一個層級,目錄數量就會加倍,因此在層級 8 時會產生 4096 個目錄,這也是預設值和最大值。子目錄會組織為 2 個層級,第一層級始終有固定的 16 個目錄。

最小值:0,最大值:8,預設值:8

此標籤需要將 CREATE_SUBDIRS 標籤設定為 YES

ALLOW_UNICODE_NAMES

如果 ALLOW_UNICODE_NAMES 標籤設定為 YES,Doxygen 將允許產生的檔案名稱中出現非 ASCII 字元。如果設定為 NO,則非 ASCII 字元將會被跳脫,例如 Unicode U+3044 會使用 _xE3_x81_x84 表示。

預設值為:NO

OUTPUT_LANGUAGE

OUTPUT_LANGUAGE 標籤用於指定 Doxygen 產生之所有文件所使用的語言。Doxygen 將使用此資訊,以正確的語言產生所有常數輸出。

可能的值有:AfrikaansArabicArmenianBrazilianBulgarianCatalanChineseChinese-TraditionalCroatianCzechDanishDutchEnglish (美國)、EsperantoFarsi (波斯語)、FinnishFrenchGermanGreekHindiHungarianIndonesianItalianJapaneseJapanese-en (日語帶英文訊息)、KoreanKorean-en (韓語帶英文訊息)、LatvianLithuanianMacedonianNorwegianPersian (波斯語)、PolishPortugueseRomanianRussianSerbianSerbian-CyrillicSlovakSloveneSpanishSwedishTurkishUkrainianVietnamese

預設值為:English

BRIEF_MEMBER_DESC

如果 BRIEF_MEMBER_DESC 標籤設定為 YES,Doxygen 會在檔案和類別文件中列出的成員之後,包含簡短的成員描述(類似於 Javadoc)。設定為 NO 以停用此功能。

預設值為:YES

REPEAT_BRIEF

如果 REPEAT_BRIEF 標籤設定為 YES,Doxygen 會在詳細描述之前,加上成員或函數的簡短描述。
注意:如果 HIDE_UNDOC_MEMBERSBRIEF_MEMBER_DESC 都設定為 NO,則簡短描述將會被完全抑制。

預設值為:YES

ABBREVIATE_BRIEF

此標籤實作了一個半智能的簡短描述縮寫器,用於在各種清單中形成文字。如果在此清單中找到任何字串作為簡短描述的前導文字,則會從文字中移除該字串,並在處理整個清單後,將結果作為註解文字。否則,將會直接使用簡短描述。如果留白,則會使用以下值($name 會自動替換為實體的名稱):The $name classThe $name widgetThe $name fileisprovidesspecifiescontainsrepresentsaanthe

ALWAYS_DETAILED_SEC

如果 ALWAYS_DETAILED_SECREPEAT_BRIEF 標籤都設定為 YES,則 Doxygen 即使只有簡短描述,也會產生詳細的章節。

預設值為:NO

INLINE_INHERITED_MEMB

如果 INLINE_INHERITED_MEMB 標籤設定為 YES,則 Doxygen 會在該類別的文件中顯示類別的所有繼承成員,就像這些成員是普通的類別成員一樣。不會顯示基底類別的建構子、解構子和賦值運算子。

預設值為:NO

FULL_PATH_NAMES

如果 FULL_PATH_NAMES 標籤設定為 YES,則 Doxygen 會在檔案清單和標頭檔中的檔案名稱前面加上完整路徑。如果設定為 NO,則會使用使檔案名稱唯一的最小路徑。

預設值為:YES

STRIP_FROM_PATH

STRIP_FROM_PATH 標籤可用於移除使用者定義的路徑部分。只有在指定的其中一個字串與路徑的左側部分匹配時,才會執行移除。此標籤可用於在檔案清單中顯示相對路徑。如果留白,則會使用執行 Doxygen 的目錄作為要移除的路徑。
請注意,您可以在此指定絕對路徑,也可以指定相對路徑,這些相對路徑將相對於 Doxygen 啟動的目錄。

此標籤需要將 FULL_PATH_NAMES 標籤設定為 YES

STRIP_FROM_INC_PATH

STRIP_FROM_INC_PATH 標籤可用於移除類別文件中提及的路徑之使用者定義部分,該路徑會告訴讀者要包含哪個標頭檔才能使用類別。如果留白,則只會使用包含類別定義的標頭檔名稱。否則,應指定通常使用 -I 旗標傳遞給編譯器的 include 路徑清單。

SHORT_NAMES

如果 SHORT_NAMES 標籤設定為 YES,Doxygen 將產生更短(但可讀性較差)的檔案名稱。如果您的檔案系統不支援像 DOS、Mac 或 CD-ROM 上的長名稱,這可能會很有用。

預設值為:NO

JAVADOC_AUTOBRIEF

如果 JAVADOC_AUTOBRIEF 標籤設定為 YES,則 Doxygen 會將 Javadoc 樣式註解的第一行(直到第一個句點、問號或驚嘆號)解讀為簡短描述。如果設定為 NO,則 Javadoc 樣式會像普通的 Qt 樣式註解一樣運作(因此需要明確的 @brief 命令才能進行簡短描述。)

預設值為:NO

JAVADOC_BANNER

如果 JAVADOC_BANNER 標籤設定為 YES,則 Doxygen 會將類似

/***************

的行解讀為 Javadoc 樣式註解「橫幅」的開頭。如果設定為 NO,則 Javadoc 樣式會像普通註解一樣運作,且不會被 Doxygen 解讀。

預設值為:NO

QT_AUTOBRIEF

如果 QT_AUTOBRIEF 標籤設定為 YES,則 Doxygen 會將 Qt 樣式註解的第一行(直到第一個句點、問號或驚嘆號)解讀為簡短描述。如果設定為 NO,則 Qt 樣式會像普通的 Qt 樣式註解一樣運作(因此需要明確的 \brief 命令才能進行簡短描述。)

預設值為:NO

MULTILINE_CPP_IS_BRIEF

可以將 MULTILINE_CPP_IS_BRIEF 標籤設定為 YES,使 Doxygen 將多行 C++ 特殊註解區塊(即 //!/// 註解區塊)視為簡短描述。這曾經是預設行為。新的預設行為是將多行 C++ 註解區塊視為詳細描述。如果您偏好舊行為,請將此標籤設定為 YES
請注意,將此標籤設定為 YES 也表示不再識別 Rational Rose 註解。

預設值為:NO

PYTHON_DOCSTRING

預設情況下,Python 文檔字串會顯示為預先格式化的文字,且無法使用 Doxygen 的特殊命令。將 PYTHON_DOCSTRING 設定為 NO 後,可以使用 Doxygen 的特殊命令,並且文檔字串文件區塊的內容會顯示為 Doxygen 文件。

預設值為:YES

INHERIT_DOCS

如果 INHERIT_DOCS 標籤設定為 YES,則未記錄的成員會從任何已記錄且重新實作的成員繼承文件。

預設值為:YES

SEPARATE_MEMBER_PAGES

如果 SEPARATE_MEMBER_PAGES 標籤設定為 YES,則 Doxygen 會為每個成員產生一個新頁面。如果設定為 NO,則成員的文件將會是包含它的檔案/類別/命名空間的一部分。

預設值為:NO

TAB_SIZE

TAB_SIZE 標籤可用於設定 Tab 中的空格數。Doxygen 會使用此值將程式碼片段中的 Tab 替換為空格。

最小值:1,最大值:16,預設值:4

ALIASES

此標籤可用於指定多個作為文件中命令的別名。別名的形式為

 name=value

例如,加入

 "sideeffect=@par Side Effects:^^"

會允許您在文件中放置命令 \sideeffect (或 @sideeffect),這會產生一個使用者定義的段落,標題為「副作用:」。請注意,您無法在別名的值部分放入 \n 來插入換行符(在產生的輸出中)。您可以在別名的值部分放入 ^^ 來插入換行符,就像原始檔案中存在實際的換行符一樣。當您需要在別名的值部分使用文字 {}, 時,必須使用反斜線 (\) 來跳脫它們,這可能會導致與命令 \{\} 衝突,對於這些命令,建議使用 @{@} 版本,或使用雙重跳脫 (\\{\\})

OPTIMIZE_OUTPUT_FOR_C

如果您的專案僅包含 C 原始碼,請將 OPTIMIZE_OUTPUT_FOR_C 標籤設定為 YES。然後,Doxygen 將產生更適合 C 的輸出。例如,所使用的一些名稱會有所不同。將會省略所有成員的清單等等。

預設值為:NO

OPTIMIZE_OUTPUT_JAVA

如果您的專案僅包含 Java 或 Python 原始碼,請將 OPTIMIZE_OUTPUT_JAVA 標籤設定為 YES。Doxygen 屆時將產生更適合該語言的輸出。例如,命名空間將以套件形式呈現,限定的範圍外觀將會不同等等。

預設值為:NO

OPTIMIZE_FOR_FORTRAN

如果您的專案包含 Fortran 原始碼,請將 OPTIMIZE_FOR_FORTRAN 標籤設定為 YES。Doxygen 屆時將產生針對 Fortran 量身打造的輸出。

預設值為:NO

OPTIMIZE_OUTPUT_VHDL

如果您的專案包含 VHDL 原始碼,請將 OPTIMIZE_OUTPUT_VHDL 標籤設定為 YES。Doxygen 屆時將產生針對 VHDL 量身打造的輸出。

預設值為:NO

OPTIMIZE_OUTPUT_SLICE

如果您的專案僅包含 Slice 原始碼,請將 OPTIMIZE_OUTPUT_SLICE 標籤設定為 YES。Doxygen 屆時將產生更適合該語言的輸出。例如,命名空間將以模組形式呈現,類型將會被區隔為更多群組等等。

預設值為:NO

EXTENSION_MAPPING

Doxygen 會根據它所剖析的檔案的副檔名來選擇要使用的剖析器。您可以使用此標籤指定要將哪個剖析器用於給定的副檔名。Doxygen 具有內建的對應,但您可以使用此標籤覆寫或擴充它。格式為 ext=language,其中 ext 是檔案副檔名,而 language 是 Doxygen 支援的剖析器之一:IDL、Java、JavaScript、Csharp (C#)、C、C++、Lex、D、PHP、md (Markdown)、Objective-C、Python、Slice、VHDL、Fortran (固定格式 Fortran:FortranFixed,自由格式 Fortran:FortranFree,不明格式 Fortran:Fortran。在後一種情況下,剖析器會嘗試猜測程式碼是固定格式還是自由格式程式碼,這是 Fortran 類型檔案的預設值)。

例如,要讓 Doxygen 將 .inc 檔案視為 Fortran 檔案(預設為 PHP),並將 .f 檔案視為 C 檔案(預設為 Fortran),請使用:inc=Fortran f=C


注意:對於沒有副檔名的檔案,您可以使用 no_extension 作為預留位置。
請注意,對於自訂副檔名,您還需要設定 FILE_PATTERNS,否則 Doxygen 不會讀取這些檔案。指定 no_extension 時,您應該將 * 新增至 FILE_PATTERNS
另請參閱 預設檔案副檔名對應 清單。

MARKDOWN_SUPPORT

如果啟用 MARKDOWN_SUPPORT 標籤,則 Doxygen 會根據 Markdown 格式預先處理所有註解,這樣可以產生更易讀的文件。如需詳細資訊,請參閱 https://daringfireball.net/projects/markdown/。Markdown 處理的輸出會進一步由 Doxygen 處理,因此您可以將 Doxygen、HTML 和 XML 命令與 Markdown 格式混用。只有在發生回溯相容性問題時才停用。

預設值為:YES

TOC_INCLUDE_HEADINGS

TOC_INCLUDE_HEADINGS 標籤設定為非零值時,所有直到該層級的標題都會自動包含在目錄中,即使它們沒有 id 屬性也是如此。

注意
此功能目前僅適用於 Markdown 標題。

最小值:0,最大值:99,預設值:6

此標籤需要將標籤 MARKDOWN_SUPPORT 設定為 YES

MARKDOWN_ID_STYLE

MARKDOWN_ID_STYLE 標籤可用於指定產生 Markdown 標題的識別碼時所使用的演算法。注意:每個識別碼都是唯一的。

可能的值為:DOXYGEN 使用固定的 'autotoc_md' 字串,後接從 0 開始的序號,以及 GITHUB 使用標題的小寫版本,將所有空白字元取代為 '-',並移除標點符號。

預設值為:DOXYGEN

此標籤需要將標籤 MARKDOWN_SUPPORT 設定為 YES

AUTOLINK_SUPPORT

啟用時,Doxygen 會嘗試將對應於已記錄類別或命名空間的單字連結到它們對應的文件。在個別情況下,可以在單字前面加上 % 符號來防止這種連結,也可以透過將 AUTOLINK_SUPPORT 設定為 NO 來全域防止。AUTOLINK_IGNORE_WORDS 標籤中列出的單字會被排除在自動連結之外。

預設值為:YES

AUTOLINK_IGNORE_WORDS

此標籤指定一個單字清單,當與文件中單字的開頭相符時,如果透過 AUTOLINK_SUPPORT 啟用自動連結,將會抑制自動連結的產生。此清單不會影響使用 # 或 \link\ref 命令明確建立的連結。

此標籤需要將標籤 AUTOLINK_SUPPORT 設定為 YES

BUILTIN_STL_SUPPORT

如果您使用 STL 類別(即 std::stringstd::vector 等),但不想要將 STL 來源(的標籤檔案)做為輸入包含進來,則應該將此標籤設定為 YES,以便讓 Doxygen 比對引數包含 STL 類別的函式宣告和定義(例如,func(std::string); 與 func(std::string) {})。這也會讓包含 STL 類別的繼承和協作圖表更完整且準確。

預設值為:NO

CPP_CLI_SUPPORT

如果您使用 Microsoft 的 C++/CLI 語言,則應該將此選項設定為 YES 以啟用剖析支援。

預設值為:NO

SIP_SUPPORT

如果您的專案僅包含 sip 來源,請將 SIP_SUPPORT 標籤設定為 YES。Doxygen 會像剖析一般的 C++ 一樣剖析它們,但會假設所有類別在沒有明確的保護關鍵字時,都使用 public 而不是 private 繼承。

預設值為:NO

IDL_PROPERTY_SUPPORT

對於 Microsoft 的 IDL,有 propgetpropput 屬性來指示屬性的 getter 和 setter 方法。將此選項設定為 YES 將使 Doxygen 在文件中以屬性取代 get 和 set 方法。這僅在這些方法確實是取得或設定簡單類型時才會有效。如果不是這種情況,或者您無論如何都想要顯示這些方法,則應該將此選項設定為 NO

預設值為:YES

DISTRIBUTE_GROUP_DOC

如果在文件中使用成員群組,並且 DISTRIBUTE_GROUP_DOC 標籤設定為 YES,則 Doxygen 會為群組的其他成員重複使用群組中第一個成員的文件(如果有的話)。預設情況下,群組的所有成員都必須明確記錄。

預設值為:NO

GROUP_NESTED_COMPOUNDS

如果您將結構或類別新增至群組,並且啟用此選項,則任何巢狀類別或結構也會新增至同一個群組。預設情況下,此選項為停用狀態,而且必須透過 \ingroup 明確新增巢狀複合。

預設值為:NO

SUBGROUPING

SUBGROUPING 標籤設定為 YES,以允許將相同類型的類別成員群組(例如公用函式群組)置於該類型的子群組中(例如,在「公用函式」區段下)。將其設定為 NO 可防止子群組。或者,可以使用 \nosubgrouping 命令按類別執行此操作。

預設值為:YES

INLINE_GROUPED_CLASSES

INLINE_GROUPED_CLASSES 標籤設定為 YES 時,類別、結構和聯集會顯示在它們所包含的群組內(例如,使用 \ingroup),而不是在單獨的頁面(針對 HTML 和 Man 頁面)或區段(針對 $\mbox{\LaTeX}$ 和 RTF)中顯示。
請注意,此功能無法與 SEPARATE_MEMBER_PAGES 組合使用。

預設值為:NO

INLINE_SIMPLE_STRUCTS

INLINE_SIMPLE_STRUCTS 標籤設定為 YES 時,只有公用資料欄位或簡單 typedef 欄位的結構、類別和聯集會內嵌顯示在定義它們的範圍文件(即檔案、命名空間或群組文件)中,前提是此範圍文件已記錄。如果設定為 NO,則結構、類別和聯集會顯示在單獨的頁面(針對 HTML 和 Man 頁面)或區段(針對 $\mbox{\LaTeX}$ 和 RTF)中。

預設值為:NO

TYPEDEF_HIDES_STRUCT

啟用 TYPEDEF_HIDES_STRUCT 標籤時,結構、聯集或列舉的 typedef 會記錄為具有 typedef 名稱的結構、聯集或列舉。因此,typedef struct TypeS {} TypeT 將會在文件中顯示為名稱為 TypeT 的結構。停用時,typedef 會顯示為檔案、命名空間或類別的成員。而結構會被命名為 TypeS。如果程式碼慣例規定所有複合類型都已 typedef,且僅參考 typedef,絕不參考標籤名稱,這通常對於 C 程式碼會很有用。

預設值為:NO

LOOKUP_CACHE_SIZE

可以使用 LOOKUP_CACHE_SIZE 設定符號查找快取的大小。此快取用於根據符號的名稱和範圍來解析符號。由於這可能是一個耗費資源的過程,而且相同的符號通常會多次出現在程式碼中,因此 Doxygen 會保留預先解析符號的快取。如果快取太小,Doxygen 將會變慢。如果快取太大,則會浪費記憶體。快取大小由以下公式給出:$2^{(16+\mbox{LOOKUP\_CACHE\_SIZE})}$。有效範圍為 0..9,預設值為 0,對應的快取大小為 $2^{16} = 65536$ 個符號。在執行結束時,Doxygen 將會報告快取使用情況,並從速度的角度建議最佳快取大小。

最小值:0,最大值:9,預設值:0

NUM_PROC_THREADS

NUM_PROC_THREADS 指定 Doxygen 在處理期間允許使用的執行緒數目。當設定為 0 時,Doxygen 會根據系統中可用的核心數目來決定。您可以將其明確設定為大於 0 的值,以更精確地控制 CPU 負載和處理速度之間的平衡。目前,只有輸入處理可以使用多個執行緒完成。由於這仍然是一項實驗性功能,因此預設值設定為 1,這實際上會停用平行處理。請回報您遇到的任何問題。平行產生 dot 圖表由 DOT_NUM_THREADS 設定控制。

最小值:0,最大值:32,預設值:1

TIMESTAMP

如果 TIMESTAMP 標籤設定為非 NO 的值,則每個產生的頁面將包含頁面產生的日期或日期和時間。將此設定為 NO 有助於比較多次執行的輸出結果。

可能的值為:YESNODATETIMEDATE

預設值為:NO

建置相關的組態選項

EXTRACT_ALL

如果 EXTRACT_ALL 標籤設定為 YES,Doxygen 會假設文件中所有實體都已記錄,即使沒有可用的文件。除非 EXTRACT_PRIVATEEXTRACT_STATIC 標籤分別設定為 YES,否則將會隱藏私有類別成員和靜態檔案成員。

注意
WARNINGS 設定為 YES 時,這也會停用通常會產生的關於未記錄成員的警告。

預設值為:NO

EXTRACT_PRIVATE

如果 EXTRACT_PRIVATE 標籤設定為 YES,則類別的所有私有成員將會包含在文件中。

預設值為:NO

EXTRACT_PRIV_VIRTUAL

如果 EXTRACT_PRIV_VIRTUAL 標籤設定為 YES,則類別中已記錄的私有虛擬方法將會包含在文件中。

預設值為:NO

EXTRACT_PACKAGE

如果 EXTRACT_PACKAGE 標籤設定為 YES,則所有具有 package 或 internal 範圍的成員將會包含在文件中。

預設值為:NO

EXTRACT_STATIC

如果 EXTRACT_STATIC 標籤設定為 YES,則檔案的所有靜態成員將會包含在文件中。

預設值為:NO

EXTRACT_LOCAL_CLASSES

如果 EXTRACT_LOCAL_CLASSES 標籤設定為 YES,則在原始碼檔案中本機定義的類別(和結構)將會包含在文件中。如果設定為 NO,則只會包含在標頭檔中定義的類別。對於 Java 原始碼沒有任何影響。

預設值為:YES

EXTRACT_LOCAL_METHODS

此旗標僅對 Objective-C 程式碼有用。如果設定為 YES,則實作部分中定義但介面中沒有定義的本機方法將會包含在文件中。如果設定為 NO,則只會包含介面中的方法。

預設值為:NO

EXTRACT_ANON_NSPACES

如果此旗標設定為 YES,則匿名命名空間的成員將會被提取並以名為 'anonymous_namespace{file}' 的命名空間出現在文件中,其中 file 將會被包含匿名命名空間的檔案的基本名稱取代。預設情況下,匿名命名空間會被隱藏。

預設值為:NO

RESOLVE_UNNAMED_PARAMS

如果此旗標設定為 YES,則宣告中未命名參數的名稱將會由相應的定義決定。預設情況下,未命名參數在輸出中保持未命名。

預設值為:YES

HIDE_UNDOC_MEMBERS

如果 HIDE_UNDOC_MEMBERS 標籤設定為 YES,Doxygen 將會隱藏已記錄類別或檔案內所有未記錄的成員。如果設定為 NO,這些成員將會包含在各種概觀中,但不會產生文件區段。如果啟用 EXTRACT_ALL,此選項無效。

預設值為:NO

HIDE_UNDOC_CLASSES

如果 HIDE_UNDOC_CLASSES 標籤設定為 YES,Doxygen 將會隱藏類別階層中通常可見的所有未記錄類別。如果設定為 NO,這些類別將會包含在各種概觀中。如果啟用此選項,也會隱藏未記錄的 C++ 概念。如果啟用 EXTRACT_ALL,此選項無效。

預設值為:NO

HIDE_UNDOC_NAMESPACES

如果 HIDE_UNDOC_NAMESPACES 標籤設定為 YES,Doxygen 將會隱藏命名空間階層中通常可見的所有未記錄命名空間。如果設定為 NO,這些命名空間將會包含在各種概觀中。如果啟用 EXTRACT_ALL,此選項無效。

預設值為:YES

HIDE_FRIEND_COMPOUNDS

如果 HIDE_FRIEND_COMPOUNDS 標籤設定為 YES,Doxygen 將會隱藏所有 friend 宣告。如果設定為 NO,這些宣告將會包含在文件中。

預設值為:NO

HIDE_IN_BODY_DOCS

如果 HIDE_IN_BODY_DOCS 標籤設定為 YES,Doxygen 將會隱藏在函式主體內找到的任何文件區塊。如果設定為 NO,這些區塊將會附加到函式的詳細文件區塊。

預設值為:NO

INTERNAL_DOCS

INTERNAL_DOCS 標籤決定是否包含在 \internal 命令之後輸入的文件。如果標籤設定為 NO,則文件將會被排除。將其設定為 YES 以包含內部文件。

預設值為:NO

CASE_SENSE_NAMES

透過正確設定 CASE_SENSE_NAMES 選項,Doxygen 將能夠更好地符合底層檔案系統的功能。

如果檔案系統區分大小寫(也就是說,它支援相同目錄下名稱僅在大小寫上不同的檔案),則必須將選項設定為 YES,以便在這些檔案出現在輸入中時正確處理。

對於不區分大小寫的檔案系統,選項應設定為 NO,以便正確處理為僅在大小寫上不同的符號寫入的輸出檔案,例如對於兩個類別,一個名為 CLASS,另一個名為 Class,並且也支援參照檔案而無需指定精確匹配的大小寫。

在 Windows(包括 Cygwin)和 macOS 上,使用者通常應將此選項設定為 NO,而在 Linux 或其他 Unix 風格的系統上,通常應將其設定為 YES

可能的值為:SYSTEMNOYES

預設值為:SYSTEM

HIDE_SCOPE_NAMES

如果 HIDE_SCOPE_NAMES 標籤設定為 NO,則 Doxygen 將會在文件中顯示具有完整類別和命名空間範圍的成員。如果設定為 YES,則範圍將會被隱藏。

預設值為:NO

HIDE_COMPOUND_REFERENCE

如果 HIDE_COMPOUND_REFERENCE 標籤設定為 NO(預設),則 Doxygen 將會在頁面的標題中附加額外的文字,例如「類別參考」。如果設定為 YES,則複合參考將會被隱藏。

預設值為:NO

SHOW_HEADERFILE

如果 SHOW_HEADERFILE 標籤設定為 YES,則類別的文件將會顯示使用該類別需要包含的檔案。

預設值為:YES

SHOW_INCLUDE_FILES

如果 SHOW_INCLUDE_FILES 標籤設定為 YES,則 Doxygen 將會在該檔案的文件中放入檔案所包含的檔案清單。

預設值為:YES

SHOW_GROUPED_MEMB_INC

如果 SHOW_GROUPED_MEMB_INC 標籤設定為 YES,則 Doxygen 將會為每個群組成員在文件中新增一個 include 陳述式,告訴讀者為了使用該成員需要包含哪個檔案。

預設值為:NO

FORCE_LOCAL_INCLUDES

如果 FORCE_LOCAL_INCLUDES 標籤設定為 YES,則 Doxygen 將會在文件中使用雙引號而不是尖括號列出包含檔案。

預設值為:NO

INLINE_INFO

如果 INLINE_INFO 標籤設定為 YES,則會在文件中插入 [inline] 標籤用於內聯成員。

預設值為:YES

SORT_MEMBER_DOCS

如果 SORT_MEMBER_DOCS 標籤設定為 YES,則 Doxygen 將會按照成員名稱的字母順序排序檔案和類別成員的(詳細)文件。如果設定為 NO,則成員將會按照宣告順序顯示。

預設值為:YES

SORT_BRIEF_DOCS

如果 SORT_BRIEF_DOCS 標籤設定為 YES,則 Doxygen 將會按照成員名稱的字母順序排序檔案、命名空間和類別成員的簡短描述。如果設定為 NO,則成員將會按照宣告順序顯示。請注意,這也會影響類別列表中的類別順序。

預設值為:NO

SORT_MEMBERS_CTORS_1ST

如果 SORT_MEMBERS_CTORS_1ST 標籤設定為 YES,則 Doxygen 將會排序類別成員的(簡短和詳細)文件,以便先列出建構子和解構子。如果設定為 NO,則建構子將會按照 SORT_BRIEF_DOCSSORT_MEMBER_DOCS 定義的各自順序顯示。

注意
如果 SORT_BRIEF_DOCS 設定為 NO,則此選項會被忽略,不排序簡短成員文件。
如果 SORT_MEMBER_DOCS 設定為 NO,則此選項會被忽略,不排序詳細成員文件。

預設值為:NO

SORT_GROUP_NAMES

如果 SORT_GROUP_NAMES 標籤設定為 YES,則 Doxygen 將會按照字母順序排序群組名稱的階層。如果設定為 NO,則群組名稱將會按照其定義的順序顯示。

預設值為:NO

SORT_BY_SCOPE_NAME

如果 SORT_BY_SCOPE_NAME 標籤設定為 YES,則類別列表將會按照完整限定名稱(包括命名空間)排序。如果設定為 NO,則類別列表將只會按照類別名稱排序,不包括命名空間部分。

注意
如果 HIDE_SCOPE_NAMES 設定為 YES,則此選項不是很有用。
此選項僅適用於類別列表,不適用於字母列表。

預設值為:NO

STRICT_PROTO_MATCHING

如果啟用 STRICT_PROTO_MATCHING 選項,且 Doxygen 無法正確解析函式的所有參數類型,即使只有一個候選或通過簡單的字串匹配就可以明顯選擇哪個候選,它也會拒絕成員函式的原型和實作之間的匹配。通過停用 STRICT_PROTO_MATCHING,在這種情況下,Doxygen 仍然會接受原型和實作之間的匹配。

預設值為:NO

GENERATE_TODOLIST

GENERATE_TODOLIST 標籤可用於啟用 (YES) 或停用 (NO) todo 列表。此列表是通過在文件中放入 \todo 命令建立的。

預設值為:YES

GENERATE_TESTLIST

GENERATE_TESTLIST 標籤可用於啟用 (YES) 或停用 (NO) 測試列表。此列表是通過在文件中放入 \test 命令建立的。

預設值為:YES

GENERATE_BUGLIST

GENERATE_BUGLIST 標籤可用於啟用 (YES) 或停用 (NO) bug 列表。此列表是通過在文件中放入 \bug 命令建立的。

預設值為:YES

GENERATE_DEPRECATEDLIST

GENERATE_DEPRECATEDLIST 標籤可用於啟用 (YES) 或停用 (NO) 已棄用列表。此列表是通過在文件中放入 \deprecated 命令建立的。

預設值為:YES

ENABLED_SECTIONS

ENABLED_SECTIONS 標籤可用於啟用條件式文件區段,以 \if <section_label> ... \endif\cond <section_label> ... \endcond 區塊標記。

MAX_INITIALIZER_LINES

MAX_INITIALIZER_LINES 標籤決定變數或巨集 / 定義的初始值在文件中顯示時,所能擁有的最大行數。如果初始化的行數超過此處指定的值,將會被隱藏。使用 0 值可完全隱藏初始化值。個別變數和巨集 / 定義值的顯示方式可以使用文件中的 \showinitializer\hideinitializer 命令來控制,而不受此設定影響。

最小值:0,最大值:10000,預設值:30

SHOW_USED_FILES

SHOW_USED_FILES 標籤設定為 NO 可停用在類別和結構文件底部產生的檔案清單。若設定為 YES,清單將會列出用於產生文件的檔案。

預設值為:YES

SHOW_FILES

SHOW_FILES 標籤設定為 NO 可停用檔案頁面的產生。這會從快速索引和資料夾樹狀檢視(如果指定)中移除檔案項目。

預設值為:YES

SHOW_NAMESPACES

SHOW_NAMESPACES 標籤設定為 NO 可停用命名空間頁面的產生。這會從快速索引和資料夾樹狀檢視(如果指定)中移除命名空間項目。

預設值為:YES

FILE_VERSION_FILTER

FILE_VERSION_FILTER 標籤可用於指定 Doxygen 應調用的程式或腳本,以取得每個檔案的目前版本(通常來自版本控制系統)。Doxygen 將透過執行(使用 popen())命令 command input-file 來調用程式,其中 commandFILE_VERSION_FILTER 標籤的值,而 input-file 是 Doxygen 提供的輸入檔案名稱。程式寫入標準輸出的任何內容都將用作檔案版本。

使用 Shell 腳本作為 Unix 過濾器的範例

 FILE_VERSION_FILTER = "/bin/sh versionfilter.sh"


CVS 的範例 Shell 腳本

#!/bin/sh
cvs status $1 | sed -n 's/^[ \]*Working revision:[ \t]*\‍([0-9][0-9\.]*\‍).*/\1/p'


Subversion 的範例 Shell 腳本

#!/bin/sh
svn stat -v $1 | sed -n 's/^[ A-Z?\*|!]\{1,15\}/r/;s/ \{1,15\}/\/r/;s/ .*//p'


ClearCase 的範例過濾器

FILE_VERSION_FILTER = "cleartool desc -fmt \%Vn"

LAYOUT_FILE

LAYOUT_FILE 標籤可用於指定 Doxygen 將會剖析的版面配置檔案。版面配置檔案以與輸出格式無關的方式控制產生的輸出檔案的整體結構。若要建立代表 Doxygen 預設值的版面配置檔案,請使用 -l 選項執行 Doxygen。您可以選擇性地在選項後指定檔案名稱,如果省略,則會使用 DoxygenLayout.xml 作為版面配置檔案的名稱。另請參閱 變更頁面版面配置 章節以取得相關資訊。
請注意,如果您從包含名為 DoxygenLayout.xml 的檔案的目錄執行 Doxygen,即使 LAYOUT_FILE 標籤保留為空,Doxygen 也會自動剖析它。

CITE_BIB_FILES

CITE_BIB_FILES 標籤可用於指定一個或多個包含參考定義的 bib 檔案。這必須是 .bib 檔案的清單。如果省略,則會自動附加 .bib 副檔名。這需要安裝 bibtex 工具。另請參閱 https://en.wikipedia.org/wiki/BibTeX 以取得更多資訊。對於 $\mbox{\LaTeX}$,可以使用 LATEX_BIB_STYLE 控制參考書目的樣式。若要使用此功能,您需要在搜尋路徑中提供 bibtexperl。另請參閱 \cite 以取得如何建立參考的資訊。

EXTERNAL_TOOL_PATH
EXTERNAL_TOOL_PATH 標籤可用於擴充搜尋路徑(PATH 環境變數),以便可以找到 latexgs 等外部工具。
注意
使用 EXTERNAL_TOOL_PATH 指定的目錄會新增到 PATH 變數已指定的路徑之前,並按照指定的順序新增。
當從 Doxywizard 執行 Doxygen 時,此選項對於 macOS 版本 14 (Sonoma) 及更高版本特別有用,因為在這種情況下,任何使用者定義的 PATH 變更都會被忽略。macOS 上的一個典型範例是設定
EXTERNAL_TOOL_PATH = /Library/TeX/texbin /usr/local/bin
與標準路徑一起,doxygen 在啟動外部工具時使用的完整搜尋路徑將變成
PATH=/Library/TeX/texbin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin

與警告和進度訊息相關的組態選項

QUIET

QUIET 標籤可用於開啟/關閉 Doxygen 產生到標準輸出的訊息。如果將 QUIET 設定為 YES,則表示訊息已關閉。

預設值為:NO

WARNINGS

WARNINGS 標籤可用於開啟/關閉 Doxygen 產生到標準錯誤 (stderr) 的警告訊息。如果將 WARNINGS 設定為 YES,則表示警告已開啟。
提示:在撰寫文件時開啟警告。

預設值為:YES

WARN_IF_UNDOCUMENTED

如果將 WARN_IF_UNDOCUMENTED 標籤設定為 YES,則 Doxygen 將會為未記載的成員產生警告。如果將 EXTRACT_ALL 設定為 YES,則此旗標將會自動停用。

預設值為:YES

WARN_IF_DOC_ERROR

如果將 WARN_IF_DOC_ERROR 標籤設定為 YES,Doxygen 將會為文件中潛在的錯誤產生警告,例如在已記載的函式中重複記載某些參數,或記載不存在的參數,或錯誤地使用標記命令。

預設值為:YES

WARN_IF_INCOMPLETE_DOC

如果將 WARN_IF_INCOMPLETE_DOC 設定為 YES,Doxygen 將會警告不完整的函式參數文件。如果設定為 NO,Doxygen 將會接受某些參數沒有文件而不發出警告。

預設值為:YES

WARN_NO_PARAMDOC

可以啟用此 WARN_NO_PARAMDOC 選項,以取得已記載但其參數或傳回值沒有文件的函式的警告。如果設定為 NO,Doxygen 將只會警告錯誤的參數文件,而不會警告沒有文件。如果將 EXTRACT_ALL 設定為 YES,則此旗標將會自動停用。另請參閱 WARN_IF_INCOMPLETE_DOC

預設值為:NO

WARN_IF_UNDOC_ENUM_VAL

如果將 WARN_IF_UNDOC_ENUM_VAL 選項設定為 YES,Doxygen 將會警告未記載的列舉值。如果設定為 NO,Doxygen 將會接受未記載的列舉值。如果將 EXTRACT_ALL 設定為 YES,則此旗標將會自動停用。

預設值為:NO

WARN_AS_ERROR

如果將 WARN_AS_ERROR 標籤設定為 YES,則 Doxygen 在遇到警告時會立即停止。如果將 WARN_AS_ERROR 標籤設定為 FAIL_ON_WARNINGS,則 Doxygen 將會繼續執行,就像 WARN_AS_ERROR 標籤設定為 NO 一樣,但在 Doxygen 處理程序的結尾,Doxygen 將會傳回非零狀態。如果將 WARN_AS_ERROR 標籤設定為 FAIL_ON_WARNINGS_PRINT,則 Doxygen 的行為類似於 FAIL_ON_WARNINGS,但在未定義 WARN_LOGFILE 的情況下,Doxygen 將不會在其他訊息之間寫入警告訊息,而是在執行結束時寫入警告訊息,如果在 WARN_LOGFILE 中定義了警告訊息,則除了在定義的檔案中之外,還會在執行結束時顯示警告訊息,除非 WARN_LOGFILE 定義為 -,即標準輸出 (stdout),在這種情況下,行為將保持與設定 FAIL_ON_WARNINGS 相同。

可能的值有:NOYESFAIL_ON_WARNINGSFAIL_ON_WARNINGS_PRINT

預設值為:NO

WARN_FORMAT

WARN_FORMAT 標籤決定 Doxygen 可以產生的警告訊息的格式。字串應包含 $file$line$text 標籤,這些標籤將會被警告來源的檔案和行號以及警告文字取代。選擇性地,格式可以包含 $version,這將會被檔案的版本取代(如果可以透過 FILE_VERSION_FILTER 取得)。

另請參閱
WARN_LINE_FORMAT

預設值為:$file:$line: $text

WARN_LINE_FORMAT

WARN_FORMAT 命令的 $text 部分中,有可能提供對更特定位置的參考。為了更容易跳到此位置(在 Doxygen 之外),使用者可以定義自訂的「剪下」/「貼上」字串。

範例

  WARN_LINE_FORMAT = "'vi $file +$line'"
另請參閱
WARN_FORMAT

預設值為:at line $line of file $file

WARN_LOGFILE

WARN_LOGFILE 標籤可用於指定應在其中寫入警告和錯誤訊息的檔案。如果留空,輸出將會寫入標準錯誤 (stderr)。如果指定的檔案無法開啟以進行寫入,則警告和錯誤訊息將會寫入標準錯誤。當將檔案指定為 - 時,警告和錯誤訊息將會寫入標準輸出 (stdout)。

與輸入檔案相關的組態選項

INPUT

INPUT 標籤用於指定包含已記載原始檔案的檔案和/或目錄。您可以輸入檔案名稱,例如 myfile.cpp 或目錄,例如 /usr/src/myproject。用空格分隔檔案或目錄。另請參閱 FILE_PATTERNSEXTENSION_MAPPING

注意
如果此標籤為空,則會搜尋目前目錄。

INPUT_ENCODING

此標籤可用於指定 Doxygen 剖析的原始檔案的字元編碼。Doxygen 內部使用 UTF-8 編碼。Doxygen 使用 libiconv(或內建於 libc 中的 iconv)進行轉碼。請參閱 libiconv 文件以取得可能的編碼清單。

另請參閱
INPUT_FILE_ENCODING

預設值為:UTF-8

INPUT_FILE_ENCODING

此標籤可用於指定 Doxygen 剖析的原始檔案的字元編碼。INPUT_FILE_ENCODING 標籤可用於在每個檔案模式的基礎上指定字元編碼。Doxygen 將會將檔案名稱與每個模式進行比較,並在有符合的情況下,套用編碼而不是預設的 INPUT_ENCODING。字元編碼是 模式=編碼 的清單(例如 *.php=ISO-8859-1)。

另請參閱
關於支援的編碼的詳細資訊,請參閱 INPUT_ENCODING

FILE_PATTERNS

如果 INPUT 標籤的值包含目錄,您可以使用 FILE_PATTERNS 標籤來指定一個或多個萬用字元模式(例如 *.cpp*.h)來篩選目錄中的原始檔案。
請注意,對於自訂副檔名或不直接支援的副檔名,您還需要為該副檔名設定 EXTENSION_MAPPING,否則 Doxygen 不會讀取這些檔案。
請注意,預設檢查的檔案模式清單可能與 預設檔案副檔名對應 清單不同。
如果留空,則會測試以下模式:*.c*.cc*.cxx*.cxxm*.cpp*.cppm*.ccm*.c++*.c++m*.java*.ii*.ixx*.ipp*.i++*.inl*.idl*.ddl*.odl*.h*.hh*.hxx*.hpp*.h++*.ixx*.l*.cs*.d*.php*.php4*.php5*.phtml*.inc*.m*.markdown*.md*.mm*.dox (將作為 Doxygen C 註解提供)、*.py*.pyw*.f90*.f95*.f03*.f08*.f18*.f*.for*.vhd*.vhdl*.ucf*.qsf*.ice

RECURSIVE

RECURSIVE 標籤可用於指定是否也應該搜尋子目錄以查找輸入檔案。

預設值為:NO

EXCLUDE

EXCLUDE 標籤可用於指定應該從 INPUT 來源檔案中排除的檔案和/或目錄。這樣一來,您可以輕鬆地從使用 INPUT 標籤指定的根目錄樹中排除子目錄。
請注意,相對路徑是相對於執行 Doxygen 的目錄而言的。

EXCLUDE_SYMLINKS

EXCLUDE_SYMLINKS 標籤可用於選擇是否從輸入中排除符號連結(一種 Unix 檔案系統功能)的檔案或目錄。

預設值為:NO

EXCLUDE_PATTERNS

如果 INPUT 標籤的值包含目錄,您可以使用 EXCLUDE_PATTERNS 標籤來指定一個或多個萬用字元模式,以從這些目錄中排除某些檔案。
請注意,萬用字元會與絕對路徑的檔案進行比對,因此例如要排除所有測試目錄,請使用模式 */test/*

EXCLUDE_SYMBOLS

EXCLUDE_SYMBOLS 標籤可用於指定應該從輸出中排除的一個或多個符號名稱(命名空間、類別、函式等)。符號名稱可以是完整名稱、單字,或者如果使用了萬用字元 *,則可以是子字串。例如:ANamespaceAClassANamespace::AClassANamespace::*Test

EXAMPLE_PATH

EXAMPLE_PATH 標籤可用於指定包含包含範例程式碼片段的一個或多個檔案或目錄,這些程式碼片段會被包含進來(請參閱 \include 指令)。

EXAMPLE_PATTERNS

如果 EXAMPLE_PATH 標籤的值包含目錄,您可以使用 EXAMPLE_PATTERNS 標籤來指定一個或多個萬用字元模式(例如 *.cpp*.h)來篩選目錄中的來源檔案。如果留空,則會包含所有檔案。

EXAMPLE_RECURSIVE

如果將 EXAMPLE_RECURSIVE 標籤設定為 YES,則無論 RECURSIVE 標籤的值為何,都會搜尋子目錄以查找與 \include\dontinclude 指令搭配使用的輸入檔案。

預設值為:NO

IMAGE_PATH

IMAGE_PATH 標籤可用於指定包含要包含在文件中的影像的一個或多個檔案或目錄(請參閱 \image 指令)。

INPUT_FILTER

INPUT_FILTER 標籤可用於指定 Doxygen 應該為每個輸入檔案呼叫的過濾器程式。Doxygen 將透過執行 (透過 popen()) 以下命令來呼叫過濾器程式:
<filter> <input-file>
其中 <filter>INPUT_FILTER 標籤的值,而 <input-file> 是輸入檔案的名稱。然後,Doxygen 將使用過濾器程式寫入標準輸出的輸出。如果指定了 FILTER_PATTERNS,則會忽略此標籤。
請注意,過濾器不得新增或移除行;它會在程式碼掃描之前套用,但不會在產生輸出程式碼時套用。如果新增或移除行,則錨點將無法正確放置。
請注意,Doxygen 會使用已處理並寫入標準輸出的資料進行進一步處理,因此不應將其他任何內容(例如偵錯陳述式或使用的指令)寫入標準輸出(因此,在 Windows 批次檔案的情況下,請務必使用 @echo OFF)。
請注意,對於自訂擴充功能或不直接支援的擴充功能,您還需要為擴充功能設定 EXTENSION_MAPPING,否則 Doxygen 將無法正確處理檔案。

FILTER_PATTERNS

FILTER_PATTERNS 標籤可用於依據每個檔案模式指定過濾器。Doxygen 會將檔案名稱與每個模式進行比較,如果相符,則會套用過濾器。過濾器是一個形式為 pattern=filter 的清單(例如 *.cpp=my_cpp_filter)。如需有關如何使用過濾器的詳細資訊,請參閱 INPUT_FILTER。如果 FILTER_PATTERNS 標籤為空,或如果沒有任何模式符合檔案名稱,則會套用 INPUT_FILTER
請注意,對於自訂擴充功能或不直接支援的擴充功能,您還需要為擴充功能設定 EXTENSION_MAPPING,否則 Doxygen 將無法正確處理檔案。

FILTER_SOURCE_FILES

如果將 FILTER_SOURCE_FILES 標籤設定為 YES,則輸入過濾器(如果使用 INPUT_FILTER 設定)也會用於過濾用於產生要瀏覽的來源檔案的輸入檔案(也就是說,當 SOURCE_BROWSER 設定為 YES 時)。

預設值為:NO

FILTER_SOURCE_PATTERNS

FILTER_SOURCE_PATTERNS 標籤可用於指定每個檔案模式的來源過濾器。模式會覆寫 FILTER_PATTERN (如果有的話) 的設定,並且也可以使用 *.ext= (因此沒有命名過濾器) 為特定模式停用來源過濾。

此標籤要求將標籤 FILTER_SOURCE_FILES 設定為 YES

USE_MDFILE_AS_MAINPAGE

如果 USE_MDFILE_AS_MAINPAGE 標籤指的是輸入中某個 markdown 檔案的名稱,則其內容將會放置在首頁 (index.html) 上。如果您在 GitHub 上有一個專案,並且想要將簡介頁面也用於 Doxygen 輸出,則此功能會很有用。

IMPLICIT_DIR_DOCS

如果將 IMPLICIT_DIR_DOCS 標籤設定為 YES,則會在專案根目錄的子目錄中找到的任何 README.md 檔案都將用作該子目錄的文件,除非 README.md\dir\page\mainpage 指令開頭。如果設定為 NO,則 README.md 檔案需要以明確的 \dir 指令開頭才能用作目錄文件。

預設值為:YES

FORTRAN_COMMENT_AFTER

Fortran 標準規定,對於固定格式的 Fortran 程式碼,從位置 72 開始的所有字元都應視為註解。一種常見的擴充功能是允許在自動註解開始之前使用較長的行。設定 FORTRAN_COMMENT_AFTER 也可讓在自動註解開始之前處理較長的行。

最小值:7,最大值:10000,預設值:72

與來源瀏覽相關的組態選項

SOURCE_BROWSER

如果將 SOURCE_BROWSER 標籤設定為 YES,則會產生來源檔案清單。已記錄的文件實體將會與這些來源交叉參照。
注意:若要消除產生的輸出中的所有原始程式碼,請確保也將 VERBATIM_HEADERS 設定為 NO

預設值為:NO

INLINE_SOURCES

INLINE_SOURCES 標籤設定為 YES 會將函式、多行巨集、列舉或清單初始化的變數主體直接包含在文件中。

預設值為:NO

STRIP_CODE_COMMENTS

STRIP_CODE_COMMENTS 標籤設定為 YES 會指示 Doxygen 從產生的原始程式碼片段中隱藏任何特殊的註解區塊。一般的 C、C++ 和 Fortran 註解將始終保持可見。

預設值為:YES

REFERENCED_BY_RELATION

如果將 REFERENCED_BY_RELATION 標籤設定為 YES,則會為每個已記錄的文件實體列出所有參照它的已記錄函式。

預設值為:NO

REFERENCES_RELATION

如果將 REFERENCES_RELATION 標籤設定為 YES,則會為每個已記錄的函式列出該函式呼叫/使用的所有已記錄實體。

預設值為:NO

REFERENCES_LINK_SOURCE

如果將 REFERENCES_LINK_SOURCE 標籤設定為 YES,且將 SOURCE_BROWSER 標籤設定為 YES,則 REFERENCES_RELATIONREFERENCED_BY_RELATION 清單中函式的超連結將會連結到原始程式碼。否則,它們會連結到文件。

預設值為:YES

SOURCE_TOOLTIPS

如果啟用 SOURCE_TOOLTIPS (預設值),則將滑鼠游標停留在原始程式碼中的超連結上時,將會顯示工具提示,其中包含其他資訊,例如原型、簡短描述和連結到定義和文件的連結。由於這會使 HTML 檔案更大,且載入大型檔案的速度會慢一些,因此您可以選擇停用此功能。

預設值為:YES

此標籤要求將標籤 SOURCE_BROWSER 設定為 YES

USE_HTAGS

如果將 USE_HTAGS 標籤設定為 YES,則對原始程式碼的參照將會指向 htags(1) 工具產生的 HTML,而不是 Doxygen 內建的來源瀏覽器。htags 工具是 GNU 全域來源標記系統的一部分(請參閱 https://gnu.dev.org.tw/software/global/global.html)。您需要 4.8.6 或更高版本。
若要使用它,請執行下列操作

  1. 安裝最新版本的 global
  2. 在組態檔案中啟用 SOURCE_BROWSERUSE_HTAGS
  3. 請確定 INPUT 指向來源樹狀結構的根目錄
  4. 正常執行 doxygen
    Doxygen 將會呼叫 htags(而 htags 又會呼叫 gtags),因此這些工具必須可從命令列取得 (也就是說,在搜尋路徑中)。
    結果:與其使用 Doxygen 產生的來源瀏覽器,現在原始程式碼的連結將會指向 htags 的輸出。

預設值為:NO

此標籤要求將標籤 SOURCE_BROWSER 設定為 YES

VERBATIM_HEADERS

如果將 VERBATIM_HEADERS 標籤設定為 YES,則 Doxygen 將會為每個指定了 include 的類別產生標頭檔案的逐字複製。設定為 NO 以停用此功能。

另請參閱
區段 \class

預設值為:YES

CLANG_ASSISTED_PARSING

若將 CLANG_ASSISTED_PARSING 標籤設定為 YES,則 Doxygen 會使用 clang 解析器 來進行更精確的解析,但效能會降低。這對於具有大量範本的 C++ 程式碼特別有幫助,因為 Doxygen 內建的解析器缺乏必要的類型資訊。

注意
此選項是否可用取決於 Doxygen 是否使用 CMake 的 -Duse_libclang=ON 選項產生。

預設值為:NO

CLANG_ADD_INC_PATHS

若將 CLANG_ASSISTED_PARSING 標籤設定為 YES,且 CLANG_ADD_INC_PATHS 標籤也設定為 YES,則 Doxygen 會將每個輸入的目錄新增至 include 路徑。

預設值為:YES

此標籤要求 CLANG_ASSISTED_PARSING 標籤必須設定為 YES

CLANG_OPTIONS

如果啟用 clang 輔助解析,您可以提供編譯器在呼叫編譯器時通常會使用的命令列選項。請注意,Doxygen 已為 INPUTINCLUDE_PATH 指定的檔案和目錄設定 include 路徑。

此標籤要求 CLANG_ASSISTED_PARSING 標籤必須設定為 YES

CLANG_DATABASE_PATH

如果啟用 clang 輔助解析,您可以為 clang 解析器提供包含名為 compile_commands.json 檔案的目錄路徑。此檔案是編譯資料庫,其中包含建置原始檔時使用的選項。這相當於將 -p 選項指定給 clang 工具,例如 clang-check。然後,這些選項將會傳遞給解析器。任何以 CLANG_OPTIONS 指定的選項也會被加入。

注意
此選項是否可用取決於 Doxygen 是否使用 CMake 的 -Duse_libclang=ON 選項產生。

與依字母順序排列的類別索引相關的組態選項

ALPHABETICAL_INDEX

若將 ALPHABETICAL_INDEX 標籤設定為 YES,則會產生所有複合的字母索引。如果專案包含大量類別、結構、聯集或介面,請啟用此選項。

預設值為:YES

IGNORE_PREFIX

IGNORE_PREFIX 標籤可用於指定在產生索引標題時應忽略的前綴(或前綴清單)。IGNORE_PREFIX 標籤適用於類別、函式和成員名稱。該實體將被放置在移除前綴後剩餘的實體名稱第一個字母下的字母順序清單中。

此標籤要求 ALPHABETICAL_INDEX 標籤必須設定為 YES

與 HTML 輸出相關的組態選項

GENERATE_HTML

若將 GENERATE_HTML 標籤設定為 YES,則 Doxygen 會產生 HTML 輸出

預設值為:YES

HTML_OUTPUT

HTML_OUTPUT 標籤用於指定 HTML 文件將放置的位置。如果輸入相對路徑,則會將 OUTPUT_DIRECTORY 的值放在其前面。

預設目錄為:html

此標籤要求 GENERATE_HTML 標籤必須設定為 YES

HTML_FILE_EXTENSION

HTML_FILE_EXTENSION 標籤可用於指定每個產生的 HTML 頁面的副檔名(例如:.htm, .php, .asp)。

預設值為:.html

此標籤要求 GENERATE_HTML 標籤必須設定為 YES

HTML_HEADER

HTML_HEADER 標籤可用於為每個產生的 HTML 頁面指定使用者定義的 HTML 標頭檔案。如果標籤留空,Doxygen 將會產生標準標頭。
為了取得有效的 HTML,標頭檔案必須包含 Doxygen 需要的任何腳本和樣式表,這取決於所使用的組態選項(例如,設定 GENERATE_TREEVIEW)。強烈建議從使用預設標頭開始

doxygen -w html new_header.html new_footer.html new_stylesheet.css YourConfigFile

然後修改 new_header.html 檔案。

另請參閱Doxygen 使用章節,以瞭解如何產生 Doxygen 通常使用的預設標頭。

注意
標頭可能會變更,因此當升級到較新版本的 Doxygen 時,您通常必須重新產生預設標頭。以下標記在標頭和頁尾內具有特殊含義
$title
將會被替換為頁面的標題。
$datetime
將會被替換為目前的日期和時間。
$date
將會被替換為目前的日期。
$time
將會被替換為目前的時間。
$year
將會被替換為目前的年份。
$showdate(<format>)
將會根據 <format> 指定的格式替換為目前的日期和時間。<format> 遵循為 \showdate 命令指定的規則,但 <format> 中不允許使用 )
$doxygenversion
將會被替換為 Doxygen 的版本
$projectname
將會被替換為專案的名稱(請參閱 PROJECT_NAME
$projectnumber
將會被替換為專案編號(請參閱 PROJECT_NUMBER
$projectbrief
將會被替換為專案的簡短描述(請參閱 PROJECT_BRIEF
$projectlogo
將會被替換為專案標誌(請參閱 PROJECT_LOGO
$generatedby
將會被替換為輸出語言相依的文字「由 ... 產生」,或當 TIMESTAMP 設定時,替換為輸出語言相依的文字「於 $datetime$projectname 產生」。
$stylesheet
將會被替換為 HTML_STYLESHEET 的設定,除非該設定為空白,否則會被替換為預設設定 doxygen.css
$extrastylesheet
將會被替換為 HTML_EXTRA_STYLESHEET 的設定,包括每個額外樣式表所需的 HTML 標籤。
$treeview
將會被替換為導覽樹所需的 JavaScript 和樣式表連結(或當 GENERATE_TREEVIEW 停用時,則為空字串)。
$search
將會被替換為搜尋引擎所需的 JavaScript 和樣式表連結(或當 SEARCHENGINE 停用時,則為空字串)。
$searchbox
將會被替換為顯示搜尋方塊所需的 HTML 程式碼(或當 SEARCHENGINE 停用時,則為空字串)。
$mathjax
將會被替換為 MathJax 功能所需的 JavaScript 和樣式表連結(或當 USE_MATHJAX 停用時,則為空字串)。
$relpath^
如果啟用 CREATE_SUBDIRS,則可以使用命令 $relpath^ 來產生指向 HTML 輸出目錄根目錄的相對路徑,例如使用 $relpath^doxygen.css 來參照標準樣式表。
$navpath
將會被替換為 GENERATE_TREEVIEW 所需的路徑

為了處理標頭和頁尾的版面配置差異,這些版面配置差異取決於組態設定,標頭也可以包含特殊區塊,這些區塊會根據組態複製到輸出或略過。這類區塊具有下列形式

 <!--BEGIN BLOCKNAME-->
 Some context copied when condition BLOCKNAME holds
 <!--END BLOCKNAME-->
 <!--BEGIN !BLOCKNAME-->
 Some context copied when condition BLOCKNAME does not hold
 <!--END !BLOCKNAME-->

支援下列區塊名稱

DISABLE_INDEX
如果啟用 DISABLE_INDEX 選項(因此當索引停用時),則此區塊內的內容會複製到輸出。
GENERATE_TREEVIEW
如果啟用 GENERATE_TREEVIEW 選項,則此區塊內的內容會複製到輸出。
SEARCHENGINE
如果啟用 SEARCHENGINE 選項,則此區塊內的內容會複製到輸出。
PROJECT_NAME
如果 PROJECT_NAME 選項不為空,則此區塊內的內容會複製到輸出。
PROJECT_NUMBER
如果 PROJECT_NUMBER 選項不為空,則此區塊內的內容會複製到輸出。
PROJECT_BRIEF
如果 PROJECT_BRIEF 選項不為空,則此區塊內的內容會複製到輸出。
PROJECT_LOGO
如果 PROJECT_LOGO 選項不為空,則此區塊內的內容會複製到輸出。
FULL_SIDEBAR
如果 FULL_SIDEBARDISABLE_INDEXGENERATE_TREEVIEW 選項都啟用,則此區塊內的內容會複製到輸出。
TITLEAREA
如果在每個頁面的頂部顯示標題,則此區塊內的內容會複製到輸出。如果填入 PROJECT_NAMEPROJECT_BRIEFPROJECT_LOGO 或如果啟用 DISABLE_INDEXSEARCHENGINE,則會出現這種情況。

此標籤要求 GENERATE_HTML 標籤必須設定為 YES

HTML_FOOTER

HTML_FOOTER 標籤可用於為每個產生的 HTML 頁面指定使用者定義的 HTML 頁尾。如果標籤留空,Doxygen 將會產生標準頁尾。

請參閱 HTML_HEADER 以瞭解更多關於如何產生預設頁尾,以及頁尾內可使用的特殊指令。

另請參閱 Doxygen 使用方式 章節,以瞭解如何產生 Doxygen 正常使用的預設頁尾。

此標籤要求將 GENERATE_HTML 標籤設定為 YES

HTML_STYLESHEET

HTML_STYLESHEET 標籤可用於指定每個 HTML 頁面所使用的使用者定義階層式樣式表。它可用於微調 HTML 輸出的外觀。如果留空,Doxygen 將產生預設樣式表。

另請參閱 Doxygen 使用方式 章節,以瞭解如何產生 Doxygen 正常使用的樣式表。

注意
建議使用 HTML_EXTRA_STYLESHEET 而非此標籤,因為它更為穩健,且此標籤 (HTML_STYLESHEET) 未來將會被淘汰。

此標籤要求將 GENERATE_HTML 標籤設定為 YES

HTML_EXTRA_STYLESHEET
HTML_EXTRA_STYLESHEET 標籤可用於指定在 Doxygen 建立的標準樣式表之後包含的額外使用者定義階層式樣式表。使用此選項可以覆蓋某些樣式方面。這比使用 HTML_STYLESHEET 更佳,因為它不會取代標準樣式表,因此對於未來更新更為穩健。Doxygen 會將樣式表檔案複製到輸出目錄。
注意
額外樣式表檔案的順序非常重要 (例如,清單中的最後一個樣式表會覆蓋清單中先前樣式表的設定)。
由於目前無法在 Webkit/Chromium 中覆蓋捲軸的樣式,如果已指定一個或多個額外樣式表,則樣式將會從預設的 doxygen.css 中省略。因此,如果需要自訂捲軸,則必須明確新增。以下是一個範例樣式表,可讓內容區域具有固定寬度。
body {
        background-color: #CCC;
        color: black;
        margin: 0;
}

div.contents {
        margin-bottom: 10px;
        padding: 12px;
        margin-left: auto;
        margin-right: auto;
        width: 960px;
        background-color: white;
        border-radius: 8px;
}

#titlearea {
        background-color: white;
}

hr.footer {
        display: none;
}

.footer {
        background-color: #AAA;
}
此標籤要求將 GENERATE_HTML 標籤設定為 YES
HTML_EXTRA_FILES

HTML_EXTRA_FILES 標籤可用於指定一個或多個應複製到 HTML 輸出目錄的額外圖像或其他原始檔。請注意,這些檔案將會複製到基礎 HTML 輸出目錄。在 HTML_HEADER 和/或 HTML_FOOTER 檔案中使用 $relpath^ 標記來載入這些檔案。在 HTML_STYLESHEET 檔案中,僅使用檔案名稱。另請注意,這些檔案將會原樣複製;沒有可用的指令或標記。

此標籤要求將 GENERATE_HTML 標籤設定為 YES

HTML_COLORSTYLE

HTML_COLORSTYLE 標籤可用於指定產生的 HTML 輸出應該以深色或淺色主題呈現。

可能的值包括:LIGHT 總是產生淺色模式輸出、DARK 總是產生深色模式輸出、AUTO_LIGHT 根據使用者偏好自動設定模式,如果沒有設定偏好則使用淺色模式 (預設值)、AUTO_DARK 根據使用者偏好自動設定模式,如果沒有設定偏好則使用深色模式,以及 TOGGLE 允許使用者透過按鈕在淺色和深色模式之間切換。

預設值為:AUTO_LIGHT

此標籤要求將 GENERATE_HTML 標籤設定為 YES

HTML_COLORSTYLE_HUE

HTML_COLORSTYLE_HUE 標籤控制 HTML 輸出的色彩。Doxygen 會根據此色彩調整樣式表和背景影像中的色彩。色調會指定為色輪上的角度,請參閱 https://en.wikipedia.org/wiki/Hue 以取得更多資訊。例如,值 0 代表紅色,60 代表黃色,120 代表綠色,180 代表青色,240 代表藍色,300 代表紫色,而 360 再次代表紅色。

最小值:0,最大值:359,預設值:220

此標籤要求將 GENERATE_HTML 標籤設定為 YES

HTML_COLORSTYLE_SAT

HTML_COLORSTYLE_SAT 標籤控制 HTML 輸出中色彩的純度 (或飽和度)。當值為 0 時,輸出將僅使用灰階。值為 255 將產生最鮮豔的色彩。

最小值:0,最大值:255,預設值:100

此標籤要求將 GENERATE_HTML 標籤設定為 YES

HTML_COLORSTYLE_GAMMA

HTML_COLORSTYLE_GAMMA 標籤控制套用至 HTML 輸出中色彩亮度元件的伽瑪校正。低於 100 的值會逐漸使輸出變亮,而高於 100 的值會使輸出變暗。除以 100 的值是實際套用的伽瑪值,因此 80 代表伽瑪值為 0.8,220 代表伽瑪值為 2.2,而 100 則不會變更伽瑪值。

最小值:40,最大值:240,預設值:80

此標籤要求將 GENERATE_HTML 標籤設定為 YES

HTML_DYNAMIC_MENUS

如果將 HTML_DYNAMIC_MENUS 標籤設定為 YES,則產生的 HTML 文件將包含一個主要索引,其中包含透過 JavaScript 動態建立的垂直導覽選單。如果停用,導覽索引將包含多個層級的索引標籤,這些索引標籤會靜態嵌入每個 HTML 頁面中。停用此選項以支援不具備 JavaScript 的瀏覽器,例如 Qt 說明瀏覽器。

預設值為:YES

此標籤要求將 GENERATE_HTML 標籤設定為 YES

HTML_DYNAMIC_SECTIONS

如果將 HTML_DYNAMIC_SECTIONS 標籤設定為 YES,則產生的 HTML 文件將包含可在頁面載入後隱藏和顯示的區段。

預設值為:NO

此標籤要求將 GENERATE_HTML 標籤設定為 YES

HTML_CODE_FOLDING

如果將 HTML_CODE_FOLDING 標籤設定為 YES,則可以在產生的 HTML 原始碼中動態摺疊和展開類別和函式。

預設值為:YES

此標籤要求將 GENERATE_HTML 標籤設定為 YES

HTML_COPY_CLIPBOARD

如果將 HTML_COPY_CLIPBOARD 標籤設定為 YES,則 Doxygen 會在程式碼和文字片段的右上角顯示一個圖示,讓使用者可以將其內容複製到剪貼簿。請注意,這僅在瀏覽器支援且網頁透過 安全內容 提供時才有效,即使用 https: 或 file: 通訊協定。

預設值為:YES

此標籤要求將 GENERATE_HTML 標籤設定為 YES

HTML_PROJECT_COOKIE

Doxygen 會將一些設定永久儲存在瀏覽器中 (透過例如 Cookie)。預設情況下,這些設定會套用至所有 Doxygen 產生的 HTML 頁面,包括所有專案。HTML_PROJECT_COOKIE 標籤可用於將設定儲存在專案特定的金鑰下,以便個別儲存使用者偏好設定。

此標籤要求將 GENERATE_HTML 標籤設定為 YES

HTML_INDEX_NUM_ENTRIES

使用 HTML_INDEX_NUM_ENTRIES 可以控制最初在各種樹狀結構索引中顯示的偏好項目數;使用者稍後可以動態展開和摺疊項目。Doxygen 會將樹狀結構展開到最多可顯示指定項目數的層級 (除非完全摺疊的樹狀結構已超過此數量)。因此,將項目數設定為 1 將預設產生完全摺疊的樹狀結構。0 是一個特殊值,代表無限數量的項目,且將預設產生完全展開的樹狀結構。

最小值:0,最大值:9999,預設值:100

此標籤要求將 GENERATE_HTML 標籤設定為 YES

GENERATE_DOCSET

如果將 GENERATE_DOCSET 標籤設定為 YES,則會產生可作為 Apple 的 Xcode 3 整合開發環境 (OSX 10.5 (Leopard) 中引入) 輸入的額外索引檔案。若要建立文件集,Doxygen 會在 HTML 輸出目錄中產生一個 Makefile。執行 make 將會在該目錄中產生文件集,而執行 make install 將會將文件集安裝在 ~/Library/Developer/Shared/Documentation/DocSets 中,以便 Xcode 在啟動時找到它。請參閱 https://developer.apple.com/library/archive/featuredarticles/DoxygenXcode/_index.html 以取得更多資訊。

預設值為:NO

此標籤要求將 GENERATE_HTML 標籤設定為 YES

DOCSET_FEEDNAME

此標籤決定文件集摘要的名稱。文件摘要提供一個保護傘,可在其中將來自單一供應商 (例如公司或產品套件) 的多個文件集分組。

預設值為:Doxygen generated docs

此標籤要求將 GENERATE_DOCSET 標籤設定為 YES

DOCSET_FEEDURL

此標籤決定文件集摘要的 URL。文件摘要提供一個保護傘,可在其中將來自單一供應商 (例如公司或產品套件) 的多個文件集分組。

此標籤要求將 GENERATE_DOCSET 標籤設定為 YES

DOCSET_BUNDLE_ID

此標籤指定一個字串,該字串應唯一識別文件集套件。這應該是一個反向網域名稱樣式字串,例如 com.mycompany.MyDocSet。Doxygen 將會將 .docset 附加到名稱中。

預設值為:org.doxygen.Project

此標籤要求將 GENERATE_DOCSET 標籤設定為 YES

DOCSET_PUBLISHER_ID

DOCSET_PUBLISHER_ID 標籤指定一個字串,該字串應唯一識別文件發佈者。這應該是一個反向網域名稱樣式字串,例如 com.mycompany.MyDocSet.documentation

預設值為:org.doxygen.Publisher

此標籤要求將 GENERATE_DOCSET 標籤設定為 YES

DOCSET_PUBLISHER_NAME

DOCSET_PUBLISHER_NAME 標籤識別文件發佈者。

預設值為:Publisher

此標籤要求將 GENERATE_DOCSET 標籤設定為 YES

GENERATE_HTMLHELP

如果將 GENERATE_HTMLHELP 標籤設定為 YES,Doxygen 將會產生三個額外的 HTML 索引檔案:index.hhpindex.hhcindex.hhkindex.hhp 是一個專案檔案,可以由 Windows 上的 Microsoft HTML Help Workshop 讀取。在 2021 年初,微軟將包含下載連結的原始頁面下線(HTML Help Workshop 已經維護多年)。您可以從網路封存下載 HTML Help Workshop:安裝執行檔
HTML Help Workshop 包含一個編譯器,可以將 Doxygen 產生的所有 HTML 輸出轉換為單個編譯的 HTML 檔案 (.chm)。編譯的 HTML 檔案現在被用作 Windows 98 的說明格式,並將在未來取代所有 Windows 平台上的舊 Windows 說明格式 (.hlp)。壓縮的 HTML 檔案也包含索引、目錄,並且您可以在文件中搜尋單字。HTML Workshop 也包含一個用於檢視壓縮 HTML 檔案的檢視器。

預設值為:NO

此標籤要求 GENERATE_HTML 標籤必須設定為 YES

CHM_FILE

CHM_FILE 標籤可用於指定產生的 .chm 檔案的檔案名稱。如果結果不應寫入 html 輸出目錄,您可以在檔案名稱前加上路徑。

此標籤要求 GENERATE_HTMLHELP 標籤必須設定為 YES

HHC_LOCATION

HHC_LOCATION 標籤可用於指定 HTML 說明編譯器 (hhc.exe) 的位置(包含檔案名稱的絕對路徑)。如果非空,Doxygen 將嘗試在產生的 index.hhp 上執行 HTML 說明編譯器。

必須指定檔案的完整路徑。

此標籤要求 GENERATE_HTMLHELP 標籤必須設定為 YES

GENERATE_CHI

GENERATE_CHI 標記控制是否產生單獨的 .chi 索引檔案 (YES),還是應將其包含在主要的 .chm 檔案中 (NO)。

預設值為:NO

此標籤要求 GENERATE_HTMLHELP 標籤必須設定為 YES

CHM_INDEX_ENCODING

CHM_INDEX_ENCODING 用於編碼 HtmlHelp 索引 (hhk)、內容 (hhc) 和專案檔案內容。

此標籤要求 GENERATE_HTMLHELP 標籤必須設定為 YES

BINARY_TOC

BINARY_TOC 標記控制是否在 .chm 檔案中產生二進制目錄 (YES) 或一般目錄 (NO)。此外,它還會啟用「上一頁」和「下一頁」按鈕。

預設值為:NO

此標籤要求 GENERATE_HTMLHELP 標籤必須設定為 YES

TOC_EXPAND

可以將 TOC_EXPAND 標記設定為 YES,以將群組成員的額外項目新增到 HTML 說明文件的目錄和樹狀檢視中。

預設值為:NO

此標籤要求 GENERATE_HTMLHELP 標籤必須設定為 YES

SITEMAP_URL

SITEMAP_URL 標籤用於指定使用者在部署文件時,將產生文件放置在伺服器上的完整 URL。產生的網站地圖稱為 sitemap.xml,並放置在 HTML_OUTPUT 指定的目錄中。如果未指定 SITEMAP_URL,則不會產生網站地圖。有關網站地圖協議的資訊,請參閱 https://www.sitemaps.org

此標籤要求 GENERATE_HTML 標籤必須設定為 YES

GENERATE_QHP

如果將 GENERATE_QHP 標籤設定為 YES,並且同時設定 QHP_NAMESPACEQHP_VIRTUAL_FOLDER,則將產生一個額外的索引檔案,該檔案可用作 Qt 的 qhelpgenerator 的輸入,以產生已產生 HTML 文件的 Qt 壓縮說明 (.qch)。

預設值為:NO

此標籤要求 GENERATE_HTML 標籤必須設定為 YES

QCH_FILE

如果指定了 QHG_LOCATION 標籤,則可以使用 QCH_FILE 標籤指定產生的 .qch 檔案的檔案名稱。指定的路徑相對於 HTML 輸出資料夾。

此標籤要求 GENERATE_QHP 標籤必須設定為 YES

QHP_NAMESPACE

QHP_NAMESPACE 標籤指定產生 Qt 說明專案輸出時要使用的命名空間。有關更多資訊,請參閱 Qt 說明專案 / 命名空間

預設值為:org.doxygen.Project

此標籤要求 GENERATE_QHP 標籤必須設定為 YES

QHP_VIRTUAL_FOLDER

QHP_VIRTUAL_FOLDER 標籤指定產生 Qt 說明專案輸出時要使用的命名空間。有關更多資訊,請參閱 Qt 說明專案 / 虛擬資料夾

預設值為:doc

此標籤要求 GENERATE_QHP 標籤必須設定為 YES

QHP_CUST_FILTER_NAME

如果設定了 QHP_CUST_FILTER_NAME 標籤,它會指定要新增的自訂篩選器的名稱。有關更多資訊,請參閱 Qt 說明專案 / 自訂篩選器

此標籤要求 GENERATE_QHP 標籤必須設定為 YES

QHP_CUST_FILTER_ATTRS

QHP_CUST_FILTER_ATTRS 標籤指定要新增的自訂篩選器的屬性清單。有關更多資訊,請參閱 Qt 說明專案 / 自訂篩選器

此標籤要求 GENERATE_QHP 標籤必須設定為 YES

QHP_SECT_FILTER_ATTRS

QHP_SECT_FILTER_ATTRS 標籤指定此專案篩選器區段相符的屬性清單。Qt 說明專案 / 篩選屬性

此標籤要求 GENERATE_QHP 標籤必須設定為 YES

QHG_LOCATION

QHG_LOCATION 標籤可用於指定 Qt 的 qhelpgenerator 的位置(包含檔案名稱的絕對路徑)。如果非空,Doxygen 將嘗試在產生的 .qhp 檔案上執行 qhelpgenerator。

此標籤要求 GENERATE_QHP 標籤必須設定為 YES

GENERATE_ECLIPSEHELP

如果將 GENERATE_ECLIPSEHELP 標籤設定為 YES,將產生額外的索引檔案,連同 HTML 檔案一起,構成一個 Eclipse 說明外掛程式。

若要安裝此外掛程式並使其在 Eclipse 中的說明內容選單下可用,需要將包含 HTML 和 XML 檔案的目錄內容複製到 Eclipse 的外掛程式目錄中。外掛程式目錄中的目錄名稱應與 ECLIPSE_DOC_ID 值相同。

複製後,需要重新啟動 Eclipse,說明才會顯示。

預設值為:NO

此標籤要求 GENERATE_HTML 標籤必須設定為 YES

ECLIPSE_DOC_ID

Eclipse 說明外掛程式的唯一識別碼。安裝此外掛程式時,包含 HTML 和 XML 檔案的目錄名稱也應具有此名稱。每個說明文件集都應具有自己的識別碼。

預設值為:org.doxygen.Project

此標籤要求 GENERATE_ECLIPSEHELP 標籤必須設定為 YES

DISABLE_INDEX

如果您想完全控制產生的 HTML 頁面的版面配置,可能需要停用索引並將其替換為您自己的索引。DISABLE_INDEX 標籤可用於開啟/關閉每個 HTML 頁面頂部的精簡索引(索引標籤)。值 NO 會啟用索引,值 YES 會停用索引。由於索引中的索引標籤包含與導覽樹狀目錄相同的資訊,如果您也將 GENERATE_TREEVIEW 設定為 YES,則可以將此選項設定為 YES

預設值為:YES

此標籤要求 GENERATE_HTML 標籤必須設定為 YES

GENERATE_TREEVIEW

GENERATE_TREEVIEW 標籤用於指定是否應產生樹狀索引結構以顯示階層資訊。如果將標籤值設定為 YES,則會產生一個側邊面板,其中包含樹狀索引結構(就像為 HTML 說明產生的結構一樣)。為使此功能生效,需要一個支援 JavaScript、DHTML、CSS 和框架的瀏覽器(即任何現代瀏覽器)。Windows 使用者最好使用 HTML 說明功能。

透過自訂樣式表(請參閱 HTML_EXTRA_STYLESHEET),可以進一步微調索引的外觀(請參閱 微調輸出)。例如,Doxygen 產生的預設樣式表有一個範例,說明如何在樹狀目錄的根部放置影像,而不是 PROJECT_NAME

由於樹狀結構基本上與索引標籤有相同的資訊,您可以考慮在啟用此選項時,將 DISABLE_INDEX 設定為 YES

預設值為:YES

此標籤需要將 GENERATE_HTML 標籤設定為 YES

FULL_SIDEBAR

GENERATE_TREEVIEWDISABLE_INDEX 都設定為 YES 時,FULL_SIDEBAR 選項會決定側邊欄是否僅限於樹狀結構檢視區域(值為 NO),或者是否應延伸至視窗的完整高度(值為 YES)。將此設定為 YES 會產生類似 https://docs.readthedocs.io 的版面配置,內容空間較大,但專案標誌、標題和描述的空間較小。

如果 GENERATE_TREEVIEWDISABLE_INDEX 其中之一設定為 NO,則此選項無效。

預設值為:NO

此標籤需要將 GENERATE_HTML 標籤設定為 YES

ENUM_VALUES_PER_LINE

ENUM_VALUES_PER_LINE 標籤可用於設定 Doxygen 在產生的 HTML 文件中,將多少個列舉值分組在一行顯示。
請注意,值為 0 將完全抑制列舉值在概觀區段中出現。

最小值:0,最大值:20,預設值:4

此標籤需要將 GENERATE_HTML 標籤設定為 YES

SHOW_ENUM_VALUES

SHOW_ENUM_VALUES 標籤設定後,Doxygen 會在列舉助憶符號旁邊顯示指定的列舉值。

預設值為:NO

TREEVIEW_WIDTH

如果已啟用樹狀結構檢視 (請參閱 GENERATE_TREEVIEW),則可以使用此標籤設定顯示樹狀結構的框架的初始寬度 (以像素為單位)。

最小值:0,最大值:1500,預設值:250

此標籤需要將 GENERATE_HTML 標籤設定為 YES

EXT_LINKS_IN_WINDOW

如果 EXT_LINKS_IN_WINDOW 選項設定為 YES,Doxygen 將在獨立視窗中開啟透過標籤檔案匯入的外部符號的連結。

預設值為:NO

此標籤需要將 GENERATE_HTML 標籤設定為 YES

OBFUSCATE_EMAILS

如果 OBFUSCATE_EMAILS 標籤設定為 YES,Doxygen 將會混淆電子郵件地址。

預設值為:YES

此標籤需要將 GENERATE_HTML 標籤設定為 YES

HTML_FORMULA_FORMAT

如果 HTML_FORMULA_FORMAT 選項設定為 svg,Doxygen 將使用 pdf2svg 工具(請參閱 https://github.com/dawbarton/pdf2svg)或 inkscape(請參閱 https://inkscape.org)為 HTML 輸出將公式產生為 SVG 圖像,而不是 PNG。這些圖像在縮放解析度下通常看起來會更好。

可能的值為:png(預設值)和 svg(看起來更好,但需要 pdf2svg 或 inkscape 工具)。

預設值為:png

此標籤需要將 GENERATE_HTML 標籤設定為 YES

FORMULA_FONTSIZE

使用此標籤來變更 HTML 文件中作為圖像包含的 $\mbox{\LaTeX}$ 公式字體大小。在成功執行 Doxygen 後變更字體大小時,您需要手動從 HTML 輸出目錄中移除所有 form_*.png 圖像,以強制重新產生這些圖像。

最小值:8,最大值:50,預設值:10

此標籤需要將 GENERATE_HTML 標籤設定為 YES

FORMULA_MACROFILE

FORMULA_MACROFILE 可以包含 $\mbox{\LaTeX}$ \newcommand\renewcommand 命令,以建立新的 $\mbox{\LaTeX}$ 命令,以在公式中用作建構區塊。請參閱 包含公式 章節以瞭解詳細資訊。

USE_MATHJAX

啟用 USE_MATHJAX 選項以使用 MathJax(請參閱 https://www.mathjax.org)來呈現 $\mbox{\LaTeX}$ 公式,MathJax 使用用戶端 JavaScript 進行呈現,而不是使用預先呈現的點陣圖。如果您沒有安裝 $\mbox{\LaTeX}$,或者您希望公式在 HTML 輸出中看起來更美觀,請使用此選項。啟用此選項時,您可能還需要單獨安裝 MathJax,並使用 MATHJAX_RELPATH 選項設定其路徑。

預設值為:NO

此標籤需要將 GENERATE_HTML 標籤設定為 YES

MATHJAX_VERSION

使用 MATHJAX_VERSION 可以指定要使用的 MathJax 版本。請注意,不同版本的 MathJax 對於不同的設定有不同的要求,因此在切換不同的 MathJax 版本時,可能也需要變更其他 MathJax 設定。

可能的值為:MathJax_2MathJax_3

預設值為:MathJax_2

此標籤需要將 USE_MATHJAX 標籤設定為 YES

MATHJAX_FORMAT

啟用 MathJax 後,您可以設定 MathJax 輸出所使用的預設輸出格式。有關輸出格式的更多詳細資訊,請參閱 MathJax 版本 2MathJax 版本 3

可能的值為:HTML-CSS(速度較慢,但具有最佳的相容性。這是 Mathjax 版本 2 的名稱,對於 MathJax 版本 3,這將被轉換為 chtml)、NativeMML(即 MathML。僅支援 MathJax 2。對於 MathJax 版本 3,將改用 chtml。)、chtml(這是 Mathjax 版本 3 的名稱,對於 MathJax 版本 2,這將被轉換為 HTML-CSS)和 SVG

預設值為:HTML-CSS

此標籤需要將 USE_MATHJAX 標籤設定為 YES

MATHJAX_RELPATH

啟用 MathJax 時,您需要使用 MATHJAX_RELPATH 選項指定相對於 HTML 輸出目錄的位置。目標目錄應包含 MathJax.js 腳本。例如,如果 mathjax 目錄與 HTML 輸出目錄位於同一層級,則 MATHJAX_RELPATH 應為 ../mathjax。預設值指向 MathJax 內容傳遞網路,因此您可以快速查看結果,而無需安裝 MathJax。但是,強烈建議在部署之前從 https://www.mathjax.org 安裝 MathJax 的本機副本。

預設值為

此標籤需要將 USE_MATHJAX 標籤設定為 YES

MATHJAX_EXTENSIONS

MATHJAX_EXTENSIONS 標籤可用於指定一個或多個 MathJax 擴充功能名稱,這些擴充功能應在 MathJax 呈現期間啟用。例如,對於 MathJax 版本 2(請參閱 https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions

MATHJAX_EXTENSIONS     = TeX/AMSmath TeX/AMSsymbols

例如,對於 MathJax 版本 3(請參閱 http://docs.mathjax.org/en/latest/input/tex/extensions/index.html

MATHJAX_EXTENSIONS     = ams

此標籤需要將 USE_MATHJAX 標籤設定為 YES

MATHJAX_CODEFILE

MATHJAX_CODEFILE 標籤可用於指定一個包含 JavaScript 程式碼片段的檔案,這些程式碼片段將在 MathJax 程式碼啟動時使用。有關更多詳細資訊,請參閱 MathJax 網站。例如,要停用 MathJax「數學設定」選單中的「數學渲染器」選單項目

MATHJAX_CODEFILE = disableRenderer.js

disableRenderer.js 檔案中

  MathJax.Hub.Config({
   menuSettings: {
    showRenderer: false,
   }
  });

此標籤需要將 USE_MATHJAX 標籤設定為 YES

SEARCHENGINE

啟用 SEARCHENGINE 標籤後,Doxygen 將為 HTML 輸出產生搜尋方塊。底層的搜尋引擎使用 JavaScript 和 DHTML,應可在任何現代瀏覽器上運作。請注意,當使用 HTML 說明 (GENERATE_HTMLHELP)、Qt 說明 (GENERATE_QHP) 或 docset (GENERATE_DOCSET) 時,已經有一個搜尋功能,因此通常應停用此功能。對於大型專案,基於 JavaScript 的搜尋引擎可能會很慢,因此啟用 SERVER_BASED_SEARCH 可能會提供更好的解決方案。

可以使用鍵盤進行搜尋;要跳到搜尋框,請使用 <access key> + S (<access key> 的按鍵取決於作業系統和瀏覽器,但通常是 <CTRL><ALT>/<option> 或兩者)。在搜尋框內,使用 <cursor down key> 跳到搜尋結果視窗,可以使用 <cursor keys> 來瀏覽結果。按下 <Enter> 選擇項目,或按下 <escape> 取消搜尋。當游標在搜尋框內時,可以按 <Shift>+<cursor down> 來選擇篩選選項。同樣地,使用 <cursor keys> 選擇篩選器,並使用 <Enter><escape> 來啟用或取消篩選選項。

預設值為:YES

此標籤要求標籤 GENERATE_HTML 設為 YES

SERVER_BASED_SEARCH

當啟用 SERVER_BASED_SEARCH 標籤時,搜尋引擎將使用網頁伺服器而非使用 JavaScript 的網頁用戶端來實作。

根據 EXTERNAL_SEARCH 設定,網頁伺服器搜尋有兩種形式。當停用時,Doxygen 將產生一個用於搜尋的 PHP 腳本和一個腳本使用的索引檔案。當啟用 EXTERNAL_SEARCH 時,索引和搜尋需要由外部工具提供。詳情請參閱 外部索引和搜尋 章節。

預設值為:NO

此標籤要求標籤 SEARCHENGINE 設為 YES

EXTERNAL_SEARCH

當啟用 EXTERNAL_SEARCH 標籤時,Doxygen 將不再產生用於搜尋的 PHP 腳本。相反地,搜尋結果會寫入 XML 檔案,該檔案需要由外部索引器處理。Doxygen 將調用由 SEARCHENGINE_URL 選項指定的外部搜尋引擎來取得搜尋結果。
Doxygen 附帶一個範例索引器 (doxyindexer) 和搜尋引擎 (doxysearch.cgi),它們基於開源搜尋引擎函式庫 Xapian
詳情請參閱 外部索引和搜尋 章節。

預設值為:NO

此標籤要求標籤 SEARCHENGINE 設為 YES

SEARCHENGINE_URL

當啟用 EXTERNAL_SEARCH 時,SEARCHENGINE_URL 應該指向由網頁伺服器託管的搜尋引擎,該搜尋引擎將返回搜尋結果。
Doxygen 附帶一個範例索引器 (doxyindexer) 和搜尋引擎 (doxysearch.cgi),它們基於開源搜尋引擎函式庫 Xapian。詳情請參閱 外部索引和搜尋 章節。

此標籤要求標籤 SEARCHENGINE 設為 YES

SEARCHDATA_FILE

當啟用 SERVER_BASED_SEARCHEXTERNAL_SEARCH 時,未編入索引的搜尋資料會寫入檔案,以供外部工具索引。使用 SEARCHDATA_FILE 標籤可以指定此檔案的名稱。

預設檔案為:searchdata.xml

此標籤要求標籤 SEARCHENGINE 設為 YES

EXTERNAL_SEARCH_ID

當同時啟用 SERVER_BASED_SEARCHEXTERNAL_SEARCH 時,EXTERNAL_SEARCH_ID 標籤可以用作專案的識別碼。這與 EXTRA_SEARCH_MAPPINGS 結合使用時很有用,可以搜尋多個專案並將結果重新導向到正確的專案。

此標籤要求標籤 SEARCHENGINE 設為 YES

EXTRA_SEARCH_MAPPINGS

EXTRA_SEARCH_MAPPINGS 標籤可以用於啟用搜尋 Doxygen 專案 (而非此組態檔案定義的專案),但這些專案都已新增到相同的外部搜尋索引。每個專案都需要透過 EXTERNAL_SEARCH_ID 設定唯一的 ID。然後,搜尋對應會將 ID 對應到可以找到文件之相對位置。

格式如下

EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...

此標籤要求標籤 SEARCHENGINE 設為 YES

與 LaTeX 輸出相關的組態選項

GENERATE_LATEX

如果 GENERATE_LATEX 標籤設為 YES,Doxygen 將產生 $\mbox{\LaTeX}$ 輸出。

預設值為:YES

LATEX_OUTPUT

LATEX_OUTPUT 標籤用於指定 $\mbox{\LaTeX}$ 文件將放置的位置。如果輸入相對路徑,則 OUTPUT_DIRECTORY 的值將會加在前面。

預設目錄為:latex

此標籤要求標籤 GENERATE_LATEX 設為 YES

LATEX_CMD_NAME

LATEX_CMD_NAME 標籤可以用於指定要調用的 $\mbox{\LaTeX}$ 命令名稱。
請注意,當未啟用 USE_PDFLATEX 時,預設為 latex;當啟用 USE_PDFLATEX 時,預設為 pdflatex,且當在後一種情況下選擇 latex 時,會被 pdflatex 覆寫。對於特定的輸出語言,預設值可能會有所不同,這取決於輸出語言的實作。

此標籤要求標籤 GENERATE_LATEX 設為 YES

MAKEINDEX_CMD_NAME

MAKEINDEX_CMD_NAME 標籤可以用於指定為 $\mbox{\LaTeX}$ 產生索引的命令名稱。

注意
此標籤用於 Makefile / make.bat 中。
另請參閱
LATEX_MAKEINDEX_CMD 用於產生的輸出檔案 (.tex) 中的部分。

預設檔案為:makeindex

此標籤要求標籤 GENERATE_LATEX 設為 YES

LATEX_MAKEINDEX_CMD

LATEX_MAKEINDEX_CMD 標籤可以用於指定為 $\mbox{\LaTeX}$ 產生索引的命令名稱。如果第一個字元不是反斜線 (\),則會在 $\mbox{\LaTeX}$ 程式碼中自動新增。

注意
此標籤用於產生的輸出檔案 (.tex) 中。
另請參閱
MAKEINDEX_CMD_NAME 用於 Makefile / make.bat 中的部分。

預設值為:makeindex

此標籤要求標籤 GENERATE_LATEX 設為 YES

COMPACT_LATEX

如果 COMPACT_LATEX 標籤設為 YES,Doxygen 會產生更精簡的 $\mbox{\LaTeX}$ 文件。這可能適用於小型專案,並有助於普遍節省一些樹木。

預設值為:NO

此標籤要求標籤 GENERATE_LATEX 設為 YES

PAPER_TYPE

PAPER_TYPE 標籤可以用於設定印表機使用的紙張類型。

可能的值包括:a4 (210 x 297 公釐)、letter (8.5 x 11 英吋)、legal (8.5 x 14 英吋) 和 executive (7.25 x 10.5 英吋)。

預設值為:a4

此標籤要求標籤 GENERATE_LATEX 設為 YES

EXTRA_PACKAGES

EXTRA_PACKAGES 標籤可以用於指定一或多個應該包含在 $\mbox{\LaTeX}$ 輸出中的 $\mbox{\LaTeX}$ 套件名稱。可以只使用套件名稱來指定套件,或者使用與 $\mbox{\LaTeX}$ \usepackage 命令一起使用的正確語法來指定。

例如,若要取得 times 字型,您可以指定

  EXTRA_PACKAGES=times
or
  EXTRA_PACKAGES={times}

若要將 intlimits 選項與 amsmath 套件一起使用,您可以指定

   EXTRA_PACKAGES=[intlimits]{amsmath}

如果留白,則不會包含額外的套件。

此標籤要求標籤 GENERATE_LATEX 設為 YES

LATEX_HEADER

LATEX_HEADER 標籤可以用於指定產生的 $\mbox{\LaTeX}$ 文件的使用者定義 $\mbox{\LaTeX}$ 標頭。標頭應該包含到第一個章節為止的所有內容。如果留白,Doxygen 將產生標準標頭。

強烈建議使用以下指令從預設標頭開始

doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty

然後修改檔案 new_header.tex

另請參閱Doxygen 使用章節,以瞭解如何產生 Doxygen 通常使用的預設標頭。


注意:只有在您知道自己在做什麼時才使用使用者定義的標頭!

注意
標頭可能會變更,因此當升級到較新版本的 Doxygen 時,您通常必須重新產生預設標頭。以下命令在標頭 (和頁尾) 內具有特殊含義
$title
將被專案名稱取代。
$datetime
將會被替換為目前的日期和時間。
$date
將會被替換為目前的日期。
$time
將會被替換為目前的時間。
$year
將會被替換為目前的年份。
$showdate(<format>)
將會根據 <format> 指定的格式替換為目前的日期和時間。<format> 遵循為 \showdate 命令指定的規則,但 <format> 中不允許使用 )
$doxygenversion
將會被替換為 Doxygen 的版本
$projectname
將會被替換為專案的名稱(請參閱 PROJECT_NAME
$projectnumber
將會被替換為專案編號(請參閱 PROJECT_NUMBER
$projectbrief
將會被替換為專案的簡短描述(請參閱 PROJECT_BRIEF
$projectlogo
將會被替換為專案標誌(請參閱 PROJECT_LOGO
$latexdocumentpre
將會由輸出語言相關設定取代,例如將整個文件嵌入特殊環境中 (適用於中文、日文等)。通常與頁尾中的 $latexdocumentpost 一起使用。
$latexdocumentpost
將會由輸出語言相關設定取代,例如將整個文件嵌入特殊環境中 (適用於中文、日文等)。通常與標頭中的 $latexdocumentpre 一起使用。
$generatedby
將會被替換為輸出語言相依的文字「由 ... 產生」,或當 TIMESTAMP 設定時,替換為輸出語言相依的文字「於 $datetime$projectname 產生」。
$latexcitereference
將由輸出語言相關的「參考書目」一詞版本取代。此設定通常與區塊名稱 CITATIONS_PRESENT 搭配使用。
$latexbibstyle
將由 LATEX_BIB_STYLE 設定所使用的 latex bib 樣式取代,如果未設定任何內容,則使用 bib 樣式 plain。此設定通常與區塊名稱 CITATIONS_PRESENT 搭配使用。
$latexbibfiles
將由以逗號分隔的 bib 檔案清單取代,如 CITE_BIB_FILES 設定 (在必要時會自動新增遺失的 .bib)。此設定通常與區塊名稱 CITATIONS_PRESENT 搭配使用。
$papertype
將由 PAPER_TYPE 中設定的紙張類型取代,並直接在其後附加 "paper" 一詞,以取得正確的 $\mbox{\LaTeX}$ 紙張類型。
$langISO
將由 ISO 語言名稱取代。
$languagesupport
將由指定的語言翻譯術語所需的套件的輸出語言相關設定取代。
$latexfontenc
將由要使用的字型編碼的輸出語言相關設定取代。此設定通常與區塊名稱 LATEX_FONTENC 搭配使用。
$latexfont
將由要使用的字型的輸出語言相關設定取代。
$latexemojidirectory
將由 LATEX_EMOJI_DIRECTORY 中設定的目錄取代,其中反斜線會替換為正斜線 (因此可供 $\mbox{\LaTeX}$ 使用)。如果 LATEX_EMOJI_DIRECTORY 為空,則將使用目前目錄。
$makeindex
會被 LATEX_MAKEINDEX_CMD 中設定的指令取代。如果該指令不是以反斜線開頭,則會自動在其前面加上反斜線。如果設定為空,則會使用 \makeindex 指令。
$extralatexpackages
會被用於使用在 EXTRA_PACKAGES 中設定的套件之指令取代。
$extralatexstylesheet
會被用於使用在 LATEX_EXTRA_STYLESHEET 中設定的套件之指令取代 (當副檔名為預設副檔名 .sty 時,會將此副檔名從套件名稱中移除)。
$latexspecialformulachars
會被一些常用特殊 Unicode 字元的程式碼取代(例如,上標減號、上標 2 和上標 3)。
$formulamacrofile
會被 FORMULA_MACROFILE 中設定的檔案名稱取代。此設定通常與區塊名稱 FORMULA_MACROFILE 一起使用。

為了處理標頭和頁尾版面配置中因組態設定而產生的差異,標頭和頁尾也可以包含特殊區塊,這些區塊會根據組態複製到輸出或略過。此類區塊具有以下形式:

 %%BEGIN BLOCKNAME
 Some context copied when condition BLOCKNAME holds
 %%END BLOCKNAME
 %%BEGIN !BLOCKNAME
 Some context copied when condition BLOCKNAME does not hold
 %%END !BLOCKNAME

以下區塊名稱會根據組態檔案中使用的設定進行設定:

COMPACT_LATEX
當啟用 COMPACT_LATEX 選項時,此區塊中的內容會複製到輸出。
PDF_HYPERLINKS
當啟用 PDF_HYPERLINKS 選項時,此區塊中的內容會複製到輸出。
USE_PDFLATEX
當啟用 USE_PDFLATEX 選項時,此區塊中的內容會複製到輸出。
LATEX_BATCHMODE
當啟用 LATEX_BATCHMODE 選項時,此區塊中的內容會複製到輸出。
TIMESTAMP
當啟用 TIMESTAMP 選項時,此區塊中的內容會複製到輸出。

以下區塊名稱會根據所使用的組態檔案中標籤是否有值來設定:

LATEX_FONTENC
當 Doxygen LaTeX 轉換器函數傳回要使用的字型編碼值時,此區塊中的內容會複製到輸出。它應與上述的 $latexfontenc 一起使用。
FORMULA_MACROFILE
FORMULA_MACROFILE 選項不為空時,此區塊中的內容會複製到輸出。它應與上述的 $formulamacrofile 一起使用。

以下區塊名稱會根據文件中是否使用了某個功能來設定:

CITATIONS_PRESENT
當文件中存在引文且存在相關的 .. 時,此區塊中的內容會複製到輸出。它應與上述的 $latexcitereference$latexbibstyle$latexbibfiles 一起使用。

此標籤要求將標籤 GENERATE_LATEX 設定為 YES

LATEX_FOOTER

LATEX_FOOTER 標籤可以用於為產生的 $\mbox{\LaTeX}$ 文件指定使用者定義的 $\mbox{\LaTeX}$ 頁尾。頁尾應包含最後一章之後的所有內容。如果留空,Doxygen 將會產生標準頁尾。

請參閱 LATEX_HEADER,以取得關於如何產生預設頁尾以及可以在頁尾內使用哪些特殊指令的更多資訊。

另請參閱 Doxygen 使用方式 章節,以瞭解如何產生 Doxygen 正常使用的預設頁尾。

注意:僅在您知道自己在做什麼的情況下才使用使用者定義的頁尾!

此標籤要求將標籤 GENERATE_LATEX 設定為 YES

LATEX_EXTRA_STYLESHEET
LATEX_EXTRA_STYLESHEET 標籤可以用於指定 Doxygen 建立的標準樣式表之後包含的其他使用者定義的 $\mbox{\LaTeX}$ 樣式表。使用此選項可以覆寫某些樣式方面。Doxygen 將會將樣式表檔案複製到輸出目錄。
注意
額外樣式表檔案的順序非常重要 (例如,清單中的最後一個樣式表會覆蓋清單中先前樣式表的設定)。
此標籤要求將標籤 GENERATE_LATEX 設定為 YES
LATEX_EXTRA_FILES

LATEX_EXTRA_FILES 標籤可以用於指定一個或多個額外的影像或其他來源檔案,這些檔案應複製到 LATEX_OUTPUT 輸出目錄。請注意,檔案將按原樣複製;沒有可用的指令或標記。

此標籤要求將標籤 GENERATE_LATEX 設定為 YES

PDF_HYPERLINKS

如果將 PDF_HYPERLINKS 標籤設定為 YES,則產生的 $\mbox{\LaTeX}$ 會準備好轉換為 PDF (使用 ps2pdfpdflatex)。PDF 檔案將包含連結 (就像 HTML 輸出一樣),而不是頁面參考。這使得輸出適合使用 PDF 檢視器進行線上瀏覽。

預設值為:YES

此標籤要求將標籤 GENERATE_LATEX 設定為 YES

USE_PDFLATEX

如果將 USE_PDFLATEX 標籤設定為 YES,Doxygen 將使用 LATEX_CMD_NAME 中指定的引擎,直接從 $\mbox{\LaTeX}$ 檔案產生 PDF 檔案。將此選項設定為 YES,以獲得更高品質的 PDF 文件。
另請參閱 LATEX_CMD_NAME 區段,以選取引擎。

預設值為:YES

此標籤要求將標籤 GENERATE_LATEX 設定為 YES

LATEX_BATCHMODE

LATEX_BATCHMODE 標籤表示 $\mbox{\LaTeX}$ 在發生錯誤時的行為。

可能的值為:NO 與 ERROR_STOP 相同、YES 與 BATCH 相同、BATCH 在批次模式中,終端機上不會列印任何內容,錯誤會像在每個錯誤按下 <return> 一樣滾動;TeX 嘗試輸入或從鍵盤輸入要求 (在未開啟的輸入串流上使用 \read) 的遺失檔案會導致作業中止、NON_STOP 在不停機模式中,診斷訊息將會出現在終端機上,但就像在批次模式中一樣,無法進行使用者互動、SCROLL 在滾動模式中,TeX 只會在遺失要輸入的檔案或必須進行鍵盤輸入時停止,以及 ERROR_STOP 在錯誤停止模式中,TeX 會在每個錯誤處停止,要求使用者介入。

預設值為:NO

此標籤要求將標籤 GENERATE_LATEX 設定為 YES

LATEX_HIDE_INDICES

如果將 LATEX_HIDE_INDICES 標籤設定為 YES,則 Doxygen 不會在輸出中包含索引章節 (例如檔案索引、複合索引等)。

預設值為:NO

此標籤要求將標籤 GENERATE_LATEX 設定為 YES

LATEX_BIB_STYLE

LATEX_BIB_STYLE 標籤可以用於指定用於參考書目的樣式,例如 plainnatieeetr。請參閱 https://en.wikipedia.org/wiki/BibTeX\cite 以取得更多資訊。

預設值為:plainnat

此標籤要求將標籤 GENERATE_LATEX 設定為 YES

LATEX_EMOJI_DIRECTORY

LATEX_EMOJI_DIRECTORY 標籤用於指定將從中讀取表情符號影像的 (相對或絕對) 路徑。如果輸入相對路徑,它將相對於 LATEX_OUTPUT 目錄。如果留空,則會使用 LATEX_OUTPUT 目錄。

此標籤要求將標籤 GENERATE_LATEX 設定為 YES

與 RTF 輸出相關的組態選項

GENERATE_RTF

如果將 GENERATE_RTF 標籤設定為 YES,Doxygen 將會產生 RTF 輸出。RTF 輸出針對 Word 97 進行了最佳化,並且在其他 RTF 讀取器/編輯器中可能看起來不太美觀。

預設值為:NO

RTF_OUTPUT

RTF_OUTPUT 標籤用於指定 RTF 文件將放置的位置。如果輸入相對路徑,則會在它前面加上 OUTPUT_DIRECTORY 的值。

預設目錄為:rtf

此標籤要求將標籤 GENERATE_RTF 設定為 YES

COMPACT_RTF

如果將 COMPACT_RTF 標籤設定為 YES,Doxygen 會產生更精簡的 RTF 文件。這對於小型專案可能很有用,並且一般來說可能有助於節省一些樹木。

預設值為:NO

此標籤要求將標籤 GENERATE_RTF 設定為 YES

RTF_HYPERLINKS

如果將 RTF_HYPERLINKS 標籤設定為 YES,則產生的 RTF 將包含超連結欄位。RTF 檔案將包含連結 (就像 HTML 輸出一樣),而不是頁面參考。這使得輸出適合使用 Word 或其他支援這些欄位的相容 Word 讀取器進行線上瀏覽。


注意:WordPad (write) 和其他程式不支援連結。

預設值為:NO

此標籤要求將標籤 GENERATE_RTF 設定為 YES

RTF_STYLESHEET_FILE

從檔案載入樣式表定義。語法類似於 Doxygen 的組態檔案,即一系列指派。您只需要提供取代項,遺失的定義會設定為其預設值。
另請參閱 Doxygen 使用 區段,以取得關於如何產生 Doxygen 通常使用的預設樣式表的資訊。

此標籤要求將標籤 GENERATE_RTF 設定為 YES

RTF_EXTENSIONS_FILE

設定產生 RTF 文件時使用的可選變數。語法類似於 Doxygen 的組態檔。可以使用 doxygen -e rtf extensionFile 產生範本擴充檔。

此標籤需要將 GENERATE_RTF 標籤設為 YES

RTF_EXTRA_FILES

RTF_EXTRA_FILES 標籤可用於指定一個或多個額外的圖像或其他來源檔案,這些檔案應該複製到 RTF_OUTPUT 輸出目錄。請注意,這些檔案將會原封不動地複製;沒有可用的指令或標記。

此標籤需要將 GENERATE_RTF 標籤設為 YES

與 man page 輸出相關的組態選項

GENERATE_MAN

如果將 GENERATE_MAN 標籤設為 YES,Doxygen 將會為類別和檔案產生 man page。

預設值為:NO

MAN_OUTPUT

MAN_OUTPUT 標籤用於指定 man page 的放置位置。如果輸入的是相對路徑,則會在前面加上 OUTPUT_DIRECTORY 的值。目錄 man3 會在 MAN_OUTPUT 指定的目錄內建立。

預設目錄為:man

此標籤需要將 GENERATE_MAN 標籤設為 YES

MAN_EXTENSION

MAN_EXTENSION 標籤決定附加到產生 man page 的副檔名。如果手冊章節不是以數字開頭,則會在前面加上數字 3。MAN_EXTENSION 標籤開頭的點 (.) 是可選的。

預設值為:.3

此標籤需要將 GENERATE_MAN 標籤設為 YES

MAN_SUBDIR

MAN_SUBDIR 標籤決定在 MAN_OUTPUT 內建立的目錄名稱,man page 會放置於此目錄中。預設值為 man,後面接著 MAN_EXTENSION,並移除開頭的 .。

此標籤需要將 GENERATE_MAN 標籤設為 YES

MAN_LINKS

如果將 MAN_LINKS 標籤設為 YES,且 Doxygen 產生 man 輸出,則會為實際 man page 中記錄的每個實體產生一個額外的 man 檔案。這些額外的檔案只會引用實際的 man page,但如果沒有這些檔案,man 指令將無法找到正確的頁面。

預設值為:NO

此標籤需要將 GENERATE_MAN 標籤設為 YES

與 XML 輸出相關的組態選項

GENERATE_XML

如果將 GENERATE_XML 標籤設為 YES,Doxygen 將會產生一個 XML 檔案,其中擷取程式碼的結構,包括所有文件。

預設值為:NO

XML_OUTPUT

XML_OUTPUT 標籤用於指定 XML 頁面的放置位置。如果輸入的是相對路徑,則會在前面加上 OUTPUT_DIRECTORY 的值。

預設目錄為:xml

此標籤需要將 GENERATE_XML 標籤設為 YES

XML_PROGRAMLISTING

如果將 XML_PROGRAMLISTING 標籤設為 YES,Doxygen 將會將程式碼清單(包括語法醒目提示和交叉參考資訊)傾印到 XML 輸出。請注意,啟用此選項將會大幅增加 XML 輸出的大小。

預設值為:YES

此標籤需要將 GENERATE_XML 標籤設為 YES

XML_NS_MEMB_FILE_SCOPE

如果將 XML_NS_MEMB_FILE_SCOPE 標籤設為 YES,Doxygen 也會將命名空間成員包含在檔案範圍中,以符合 HTML 輸出。

預設值為:NO

此標籤需要將 GENERATE_XML 標籤設為 YES

與 DOCBOOK 輸出相關的組態選項

GENERATE_DOCBOOK

如果將 GENERATE_DOCBOOK 標籤設為 YES,Doxygen 將會產生可用於產生 PDF 的 Docbook 檔案。

預設值為:NO

DOCBOOK_OUTPUT

DOCBOOK_OUTPUT 標籤用於指定 Docbook 頁面的放置位置。如果輸入的是相對路徑,則會在前面加上 OUTPUT_DIRECTORY 的值。

預設目錄為:docbook

此標籤需要將 GENERATE_DOCBOOK 標籤設為 YES

AutoGen Definitions 輸出的組態選項

GENERATE_AUTOGEN_DEF

如果將 GENERATE_AUTOGEN_DEF 標籤設為 YES,Doxygen 將會產生一個 AutoGen Definitions 檔案 (請參閱 https://autogen.sourceforge.net/),其中擷取程式碼的結構,包括所有文件。請注意,此功能目前仍處於實驗階段且不完整。

預設值為:NO

與 Sqlite3 輸出相關的組態選項

GENERATE_SQLITE3

如果將 GENERATE_SQLITE3 標籤設為 YES,Doxygen 將會產生一個 Sqlite3 資料庫,其中將 Doxygen 找到的符號儲存在表格中。

預設值為:NO

SQLITE3_OUTPUT

SQLITE3_OUTPUT 標籤用於指定 Sqlite3 資料庫的放置位置。如果輸入的是相對路徑,則會在前面加上 OUTPUT_DIRECTORY 的值。

預設目錄為:sqlite3

此標籤需要將 GENERATE_SQLITE3 標籤設為 YES

SQLITE3_RECREATE_DB

如果將 SQLITE3_RECREATE_DB 標籤設為 YES,則每次執行 Doxygen 時都會重新建立現有的 doxygen_sqlite3.db 資料庫檔案。如果設為 NO,Doxygen 會在找到資料庫檔案時發出警告,且不會修改該檔案。

預設值為:YES

此標籤需要將 GENERATE_SQLITE3 標籤設為 YES

與 Perl 模組輸出相關的組態選項

GENERATE_PERLMOD

如果將 GENERATE_PERLMOD 標籤設為 YES,Doxygen 將會產生一個 Perl 模組檔案,其中擷取程式碼的結構,包括所有文件。
請注意,此功能目前仍處於實驗階段且不完整。

預設值為:NO

PERLMOD_LATEX

如果將 PERLMOD_LATEX 標籤設為 YES,Doxygen 將會產生必要的 Makefile 規則、Perl 指令碼和 $\mbox{\LaTeX}$ 程式碼,以便能夠從 Perl 模組輸出產生 PDF 和 DVI 輸出。

預設值為:NO

此標籤需要將 GENERATE_PERLMOD 標籤設為 YES

PERLMOD_PRETTY

如果將 PERLMOD_PRETTY 標籤設為 YES,Perl 模組輸出將會被良好地格式化,以便人類讀者可以剖析它。如果您想了解發生了什麼事,這會很有用。另一方面,如果將此標籤設為 NO,Perl 模組輸出的尺寸將會小得多,而 Perl 也會以相同的方式剖析它。

預設值為:YES

此標籤需要將 GENERATE_PERLMOD 標籤設為 YES

PERLMOD_MAKEVAR_PREFIX

在產生的 doxyrules.make 檔案中的 make 變數名稱會加上 PERLMOD_MAKEVAR_PREFIX 中包含的字串作為前置詞。這很有用,這樣同一個 Makefile 包含的不同 doxyrules.make 檔案才不會覆寫彼此的變數。

此標籤需要將 GENERATE_PERLMOD 標籤設為 YES

與前置處理器相關的組態選項

ENABLE_PREPROCESSING

如果將 ENABLE_PREPROCESSING 標籤設為 YES,Doxygen 將會評估來源和包含檔案中找到的所有 C 前置處理器指令。

預設值為:YES

MACRO_EXPANSION

如果將 MACRO_EXPANSION 標籤設為 YES,Doxygen 將會展開原始碼中的所有巨集名稱。如果設為 NO,則只會執行條件編譯。巨集展開可以透過將 EXPAND_ONLY_PREDEF 設為 YES 來進行受控制的方式。

預設值為:NO

此標籤需要將 ENABLE_PREPROCESSING 標籤設為 YES

EXPAND_ONLY_PREDEF

如果 EXPAND_ONLY_PREDEFMACRO_EXPANSION 標籤都設為 YES,則巨集展開會限制為使用 PREDEFINEDEXPAND_AS_DEFINED 標籤指定的巨集。

預設值為:NO

此標籤需要將 ENABLE_PREPROCESSING 標籤設為 YES

SEARCH_INCLUDES

如果將 SEARCH_INCLUDES 標籤設為 YES,如果在找到 #include,則會在 INCLUDE_PATH 中的包含檔案中進行搜尋。

預設值為:YES

此標籤需要將 ENABLE_PREPROCESSING 標籤設為 YES

INCLUDE_PATH

INCLUDE_PATH 標籤可用於指定一個或多個包含檔案的目錄,這些目錄不是輸入檔案,但應該由前置處理器處理。

請注意,INCLUDE_PATH 不是遞迴的,因此設定 RECURSIVE 在此處沒有任何作用。

此標籤要求必須將 SEARCH_INCLUDES 標籤設定為 YES

INCLUDE_FILE_PATTERNS

您可以使用 INCLUDE_FILE_PATTERNS 標籤指定一個或多個萬用字元模式(如 *.h*.hpp)來篩選目錄中的標頭檔。如果留空,將使用 FILE_PATTERNS 指定的模式。

此標籤要求必須將 ENABLE_PREPROCESSING 標籤設定為 YES

PREDEFINED

PREDEFINED 標籤可用於指定一個或多個在預處理器啟動之前定義的巨集名稱(類似於 gcc-D 選項)。該標籤的參數是巨集列表,格式為:namename=definition(沒有空格)。如果省略定義和 "=",則假定為 "=1"。若要防止巨集定義透過 #undef 取消定義或遞迴展開,請使用 := 運算子而非 = 運算子。

此標籤要求必須將 ENABLE_PREPROCESSING 標籤設定為 YES

EXPAND_AS_DEFINED

如果 MACRO_EXPANSIONEXPAND_ONLY_PREDEF 標籤設定為 YES,則可以使用此標籤指定應展開的巨集名稱列表。將使用在原始碼中找到的巨集定義。如果您想使用不同的巨集定義來覆蓋原始碼中找到的定義,請使用 PREDEFINED 標籤。

此標籤要求必須將 ENABLE_PREPROCESSING 標籤設定為 YES

SKIP_FUNCTION_MACROS

如果 SKIP_FUNCTION_MACROS 標籤設定為 YES,則 Doxygen 的預處理器會移除所有對函式式巨集的參考,這些巨集單獨在一行上,具有全大寫名稱,且不以分號結尾。此類函式巨集通常用於樣板程式碼,如果不移除,會使解析器混淆。

預設值為:YES

此標籤要求必須將 ENABLE_PREPROCESSING 標籤設定為 YES

與外部參考相關的設定選項

TAGFILES

TAGFILES 標籤可用於指定一個或多個標籤檔。

對於每個標籤檔,應新增外部文件所在的位置。沒有位置的標籤檔格式如下

  TAGFILES = file1 file2 ...

為標籤檔新增位置的方式如下

  TAGFILES = file1=loc1 "file2 = loc2" ...

其中 loc1loc2 可以是相對或絕對路徑或 URL。有關標籤檔使用的更多資訊,請參閱 連結至外部文件 章節。

注意
每個標籤檔都必須具有唯一的名稱(名稱中包含路徑)。如果標籤檔不在 Doxygen 執行的目錄中,您也必須在此處指定標籤檔的路徑。

GENERATE_TAGFILE

當在 GENERATE_TAGFILE 後面指定檔案名稱時,Doxygen 會根據讀取的輸入檔建立一個標籤檔。有關標籤檔使用的更多資訊,請參閱 連結至外部文件 章節。

ALLEXTERNALS

如果 ALLEXTERNALS 標籤設定為 YES,所有外部類別和命名空間都將列在類別和命名空間索引中。如果設定為 NO,則僅會列出繼承的外部類別。

預設值為:NO

EXTERNAL_GROUPS

如果 EXTERNAL_GROUPS 標籤設定為 YES,所有外部群組都將列在主題索引中。如果設定為 NO,則僅會列出目前專案的群組。

預設值為:YES

EXTERNAL_PAGES

如果 EXTERNAL_PAGES 標籤設定為 YES,所有外部頁面都將列在相關頁面索引中。如果設定為 NO,則僅會列出目前專案的頁面。

預設值為:YES

與圖表產生器工具相關的設定選項

HIDE_UNDOC_RELATIONS

如果設定為 YES,則當目標未文件化或不是類別時,繼承和協作圖會隱藏繼承和使用關係。

預設值為:YES

HAVE_DOT

如果您將 HAVE_DOT 標籤設定為 YES,則 Doxygen 將假設 dot 工具可從 path 取得。此工具是 Graphviz 的一部分,Graphviz 是 AT&T 和 Lucent Bell Labs 的圖形視覺化工具包。如果此選項設定為 NO,則此章節中的其他選項無效。

預設值為:NO

DOT_NUM_THREADS

DOT_NUM_THREADS 指定 Doxygen 允許平行執行的 dot 呼叫次數。設定為 0 時,Doxygen 將根據系統中可用的處理器數量來決定。您可以將其明確設定為大於 0 的值,以控制 CPU 負載和處理速度之間的平衡。

最小值:0,最大值:32,預設值:0

此標籤要求必須將 HAVE_DOT 標籤設定為 YES

DOT_COMMON_ATTR

DOT_COMMON_ATTR 是子圖的節點、邊緣和標籤的通用屬性。如果您想要在 Doxygen 產生的 dot 檔案中使用不同外觀的字型,您可以指定 fontname、fontcolor 和 fontsize 屬性。有關詳細資訊,請參閱 節點、邊緣和圖形屬性規格。您需要確保 dot 能夠找到字型,這可以透過將字型放在標準位置,或設定 DOTFONTPATH 環境變數,或將 DOT_FONTPATH 設定為包含字型的目錄來完成。預設的 graphviz 字型大小為 14。

預設值為:fontname=Helvetica,fontsize=10

此標籤要求必須將 HAVE_DOT 標籤設定為 YES

DOT_EDGE_ATTR

DOT_EDGE_ATTR 會與 DOT_COMMON_ATTR 串連。若要獲得優雅的樣式,您可以新增 'arrowhead=open, arrowtail=open, arrowsize=0.5'。有關箭頭形狀的完整文件。

預設值為:labelfontname=Helvetica,labelfontsize=10

此標籤要求必須將 HAVE_DOT 標籤設定為 YES

DOT_NODE_ATTR

DOT_NODE_ATTR 會與 DOT_COMMON_ATTR 串連。若要檢視沒有節點周圍的方框,請設定 'shape=plain' 或 'shape=plaintext' 形狀規格

預設值為:shape=box,height=0.2,width=0.4

此標籤要求必須將 HAVE_DOT 標籤設定為 YES

DOT_FONTPATH

您可以設定 dot 可以找到以 DOT_COMMON_ATTR 和其他 dot 屬性中指定 fontname 的字型的路徑。

此標籤要求必須將 HAVE_DOT 標籤設定為 YES

CLASS_GRAPH

如果 CLASS_GRAPH 標籤設定為 YESGRAPHBUILTIN,則 Doxygen 會為每個文件化的類別產生一個圖表,顯示直接和間接的繼承關係。如果 CLASS_GRAPH 標籤設定為 YESGRAPH,並且也啟用了 HAVE_DOT,則會使用 dot 來繪製圖表。如果 CLASS_GRAPH 標籤設定為 YES,並且 HAVE_DOT 被停用,或者如果 CLASS_GRAPH 標籤設定為 BUILTIN,則會使用內建的產生器。如果 CLASS_GRAPH 標籤設定為 TEXT,則直接和間接的繼承關係將顯示為文字/連結。可以透過 \inheritancegraph 命令來明確啟用繼承圖,或為特定類別的繼承圖選擇不同的表示形式。可以透過 \hideinheritancegraph 命令來停用繼承圖。

可能的值為:NOYESTEXTGRAPHBUILTIN

預設值為:YES

COLLABORATION_GRAPH

如果 COLLABORATION_GRAPH 標籤設定為 YES,則 Doxygen 會為每個文件化的類別產生一個圖表,顯示該類別與其他文件化類別的直接和間接實作相依性(繼承、包含和類別參考變數)。當 COLLABORATION_GRAPH 設定為 NO 時,可以透過 \collaborationgraph 命令來明確啟用協作圖。可以透過 \hidecollaborationgraph 命令來停用協作圖。

預設值為:YES

此標籤要求必須將 HAVE_DOT 標籤設定為 YES

GROUP_GRAPHS

如果 GROUP_GRAPHS 標籤設定為 YES,則 Doxygen 會為群組產生一個圖表,顯示直接的群組相依性。當 GROUP_GRAPHS 設定為 NO 時,可以透過 \groupgraph 命令來明確啟用群組相依性圖。可以透過 \hidegroupgraph 命令來停用目錄圖。

另請參閱手冊中的分組章節。

預設值為:YES

此標籤要求將 HAVE_DOT 標籤設定為 YES

UML_LOOK

如果將 UML_LOOK 標籤設定為 YES,Doxygen 將會產生類似於 OMG 統一建模語言的繼承和協作圖表。

預設值為:NO

此標籤要求將 HAVE_DOT 標籤設定為 YES

UML_LIMIT_NUM_FIELDS

如果啟用 UML_LOOK 標籤,欄位和方法將顯示在類別節點內。如果欄位或方法過多,且節點數量也很多,圖表可能會變得過大而難以使用。UML_LIMIT_NUM_FIELDS 臨界值會限制每種類型項目的數量,以使大小更易於管理。將此值設定為 0 表示不限制。請注意,在強制執行限制之前,臨界值可能會超出 50%。因此,當您將臨界值設定為 10 時,最多可能會出現 15 個欄位,但如果數量超過 15 個,則顯示的欄位總數將限制為 10 個。

最小值:0,最大值:100,預設值:10

此標籤要求將 UML_LOOK 標籤設定為 YES

DOT_UML_DETAILS

如果將 DOT_UML_DETAILS 標籤設定為 NO,Doxygen 將在 UML 圖表中顯示沒有類型和引數的屬性和方法。如果將 DOT_UML_DETAILS 標籤設定為 YES,Doxygen 將在 UML 圖表中為屬性和方法新增類型和引數。如果將 DOT_UML_DETAILS 標籤設定為 NONE,Doxygen 將不會在 UML 圖表中產生包含類別成員資訊的欄位。類別圖將與預設類別圖相似,但關係使用 UML 表示法。

可能的值為:NOYESNONE

預設值為:NO

此標籤要求將 UML_LOOK 標籤設定為 YES

DOT_WRAP_THRESHOLD

DOT_WRAP_THRESHOLD 標籤可用於設定單行顯示的最大字元數。如果實際行長度明顯超過此臨界值,則會跨多行換行。會應用一些啟發式方法來避免難看的換行。

最小值:0,最大值:1000,預設值:17

此標籤要求將 HAVE_DOT 標籤設定為 YES

TEMPLATE_RELATIONS

如果將 TEMPLATE_RELATIONS 標籤設定為 YES,則繼承和協作圖表將顯示範本及其執行個體之間的關係。

預設值為:NO

此標籤要求將 HAVE_DOT 標籤設定為 YES

INCLUDE_GRAPH

如果將 INCLUDE_GRAPHENABLE_PREPROCESSINGSEARCH_INCLUDES 標籤設定為 YES,則 Doxygen 將為每個已記錄的文件產生一個圖表,顯示該文件與其他已記錄文件的直接和間接包含相依性。當 INCLUDE_GRAPH 設定為 NO 時,可以使用 \includegraph 命令顯式啟用包含圖表。可以使用 \hideincludegraph 命令停用包含圖表。

預設值為:YES

此標籤要求將 HAVE_DOT 標籤設定為 YES

INCLUDED_BY_GRAPH

如果將 INCLUDED_BY_GRAPHENABLE_PREPROCESSINGSEARCH_INCLUDES 標籤設定為 YES,則 Doxygen 將為每個已記錄的文件產生一個圖表,顯示該文件與其他已記錄文件的直接和間接包含相依性。當 INCLUDED_BY_GRAPH 設定為 NO 時,可以使用 \includedbygraph 命令顯式啟用被包含圖表。可以使用 \hideincludedbygraph 命令停用被包含圖表。

預設值為:YES

此標籤要求將 HAVE_DOT 標籤設定為 YES

CALL_GRAPH

如果將 CALL_GRAPH 標籤設定為 YES,則 Doxygen 將為每個全域函式或類別方法產生呼叫相依性圖表。
請注意,啟用此選項將顯著增加執行時間。因此,在大多數情況下,最好僅使用 \callgraph 命令為選定的函式啟用呼叫圖表。可以使用 \hidecallgraph 命令停用呼叫圖表。

預設值為:NO

此標籤要求將 HAVE_DOT 標籤設定為 YES

CALLER_GRAPH

如果將 CALLER_GRAPH 標籤設定為 YES,則 Doxygen 將為每個全域函式或類別方法產生呼叫者相依性圖表。
請注意,啟用此選項將顯著增加執行時間。因此,在大多數情況下,最好僅使用 \callergraph 命令為選定的函式啟用呼叫者圖表。可以使用 \hidecallergraph 命令停用呼叫者圖表。

預設值為:NO

此標籤要求將 HAVE_DOT 標籤設定為 YES

GRAPHICAL_HIERARCHY

如果將 GRAPHICAL_HIERARCHY 標籤設定為 YES,則 Doxygen 將產生所有類別的圖形階層,而不是文字階層。

預設值為:YES

此標籤要求將 HAVE_DOT 標籤設定為 YES

DIRECTORY_GRAPH

如果將 DIRECTORY_GRAPH 標籤設定為 YES,則 Doxygen 將以圖形方式顯示目錄對其他目錄的相依性。相依性關係由目錄中檔案之間的 #include 關係決定。當 DIRECTORY_GRAPH 設定為 NO 時,可以使用 \directorygraph 命令顯式啟用目錄圖表。可以使用 \hidedirectorygraph 命令停用目錄圖表。

預設值為:YES

此標籤要求將 HAVE_DOT 標籤設定為 YES

DIR_GRAPH_MAX_DEPTH

DIR_GRAPH_MAX_DEPTH 標籤可用於限制 dot 在目錄相依性圖表中產生的子目錄層級最大數量。

最小值:1,最大值:25,預設值:1

此標籤要求將 DIRECTORY_GRAPH 標籤設定為 YES

DOT_IMAGE_FORMAT

DOT_IMAGE_FORMAT 標籤可用於設定 dot 產生的影像格式。有關影像格式的說明,請參閱 dot 工具的說明文件 (Graphviz) 中的輸出格式章節。

注意
如果您選擇 svg,則需要將 HTML_FILE_EXTENSION 設定為 xhtml,才能讓 SVG 檔案在 IE 9+ 中可見 (其他瀏覽器沒有此要求)。

可能的值為:pngjpggifsvgpng:gdpng:gd:gdpng:cairopng:cairo:gdpng:cairo:cairopng:cairo:gdipluspng:gdipluspng:gdiplus:gdiplus

預設值為:png

此標籤要求將 HAVE_DOT 標籤設定為 YES

INTERACTIVE_SVG

如果將 DOT_IMAGE_FORMAT 設定為 svg,則可以將此選項設定為 YES 以啟用產生可縮放和平移的互動式 SVG 影像。
請注意,這需要非 Internet Explorer 的現代瀏覽器。已測試並可使用的瀏覽器包括 Firefox、Chrome、Safari 和 Opera。

注意
對於 IE 9+,您需要將 HTML_FILE_EXTENSION 設定為 xhtml,才能讓 SVG 檔案可見。較舊版本的 IE 不支援 SVG。

預設值為:NO

此標籤要求將 HAVE_DOT 標籤設定為 YES

DOT_PATH

DOT_PATH 標籤可用於指定可以找到 dot 工具的路徑。如果留空,則假設可以在 path 中找到 dot 工具。

此標籤要求將 HAVE_DOT 標籤設定為 YES

DOTFILE_DIRS

DOTFILE_DIRS 標籤可用於指定一個或多個包含點文件的目錄,這些點文件會包含在說明文件中 (請參閱 \dotfile 命令)。

此標籤要求將 HAVE_DOT 標籤設定為 YES

DIA_PATH

您可以在 Doxygen 說明文件中包含使用 dia 製作的圖表。然後 Doxygen 將會執行 dia 來產生圖表,並將其插入說明文件中。DIA_PATH 標籤可讓您指定 dia 二進位檔案所在目錄。如果留空,則假設可以在預設搜尋路徑中找到 dia。

DIAFILE_DIRS

DIAFILE_DIRS 標籤可用於指定一個或多個包含 dia 檔案的目錄,這些 dia 檔案會包含在說明文件中 (請參閱 \diafile 命令)。

PLANTUML_JAR_PATH

使用 PlantUML 時,應使用 PLANTUML_JAR_PATH 標籤指定 java 可以找到 plantuml.jar 檔案的路徑,或是要使用的 jar 檔案的檔案名稱。如果留空,則假設在預處理步驟中未使用或呼叫 PlantUML。Doxygen 在這種情況下遇到 \startuml 命令時,會產生警告,且不會為該圖表產生輸出。

PLANTUML_CFG_FILE

使用 PlantUML 時,可以使用 PLANTUML_CFG_FILE 標籤指定 PlantUML 的組態檔案。

PLANTUML_INCLUDE_PATH

使用 PlantUML 時,會在指定的路徑中搜尋 PlantUML 區塊中 !include 陳述式所指定之檔案。

PLANTUMLFILE_DIRS

PLANTUMLFILE_DIRS 標籤可用於指定一個或多個包含 PlantUml 檔案的目錄,這些 PlantUml 檔案會包含在說明文件中 (請參閱 \plantumlfile 命令)。

DOT_GRAPH_MAX_NODES

DOT_GRAPH_MAX_NODES 標籤可用於設定圖表中將顯示的最大節點數。如果圖表中的節點數大於此值,Doxygen 將會截斷圖表,並將節點顯示為紅色方塊。請注意,如果圖表中根節點的直接子節點數已大於 DOT_GRAPH_MAX_NODES,則根本不會顯示圖表。另請注意,可以使用 MAX_DOT_GRAPH_DEPTH 進一步限制圖表的大小。

最小值:0,最大值:10000,預設值:50

此標籤要求將 HAVE_DOT 標籤設定為 YES

MAX_DOT_GRAPH_DEPTH

MAX_DOT_GRAPH_DEPTH 標籤可用於設定 dot 所產生圖形的最大深度。深度值為 3 表示只會顯示從根節點開始,透過最多 3 條邊的路徑可到達的節點。距離根節點更遠的節點將會被省略。請注意,將此選項設定為 1 或 2 可能會大大減少大型程式碼庫所需的計算時間。另請注意,圖形的大小可以透過 DOT_GRAPH_MAX_NODES 進一步限制。使用深度 0 表示沒有深度限制。

最小值:0,最大值:1000,預設值:0

此標籤需要將 HAVE_DOT 標籤設定為 YES

DOT_MULTI_TARGETS

DOT_MULTI_TARGETS 標籤設定為 YES,允許 dot 在一次執行中產生多個輸出檔案(即命令列上有多個 -o 和 -T 選項)。這會使 dot 執行速度更快,但由於只有較新版本的 dot (>1.8.10) 支援此功能,因此預設情況下會停用此功能。

預設值為:NO

此標籤需要將 HAVE_DOT 標籤設定為 YES

GENERATE_LEGEND

如果將 GENERATE_LEGEND 標籤設定為 YES,Doxygen 將會產生一個圖例頁面,解釋 dot 產生的圖形中各種方塊和箭頭的含義。

注意
此標籤需要未設定 UML_LOOK,也就是使用 Doxygen 內部用於繼承和協作圖形的圖形表示。

預設值為:YES

此標籤需要將 HAVE_DOT 標籤設定為 YES

DOT_CLEANUP

如果將 DOT_CLEANUP 標籤設定為 YES,Doxygen 將會移除用於產生各種圖形的臨時檔案。
注意:此設定不僅用於 dot 檔案,也用於 msc 臨時檔案。

預設值為:YES

MSCGEN_TOOL

您可以在 Doxygen 註解中使用 \msc 命令定義訊息序列圖。如果 MSCGEN_TOOL 標籤為空(預設值),則 Doxygen 將會使用內建版本的 mscgen 工具來產生圖表。或者,MSCGEN_TOOL 標籤也可以指定外部工具的名稱。例如,指定 prog 作為值,Doxygen 將會呼叫該工具,像是 prog -T <outfile_format> -o <outputfile> <inputfile>。外部工具應支援 "png"、"eps"、"svg" 和 "ismap" 的輸出檔案格式。

MSCFILE_DIRS

MSCFILE_DIRS 標籤可用於指定一個或多個包含 msc 檔案的目錄,這些檔案將會被包含在文件中(請參閱 \mscfile 命令)。

範例

假設您有一個由兩個檔案組成的簡單專案:一個原始碼檔案 example.cc 和一個標頭檔案 example.h。那麼最簡化的設定檔如下:

INPUT            = example.cc example.h

假設此範例使用了 Qt 類別,且 perl 位於 /usr/bin 中,則更真實的設定檔如下:

PROJECT_NAME     = Example
INPUT            = example.cc example.h
WARNINGS         = YES
TAGFILES         = qt.tag
SEARCHENGINE     = NO

為了產生 QdbtTabular 套件的文件,我使用了以下設定檔

PROJECT_NAME     = QdbtTabular
OUTPUT_DIRECTORY = html
WARNINGS         = YES
INPUT            = examples/examples.doc src
FILE_PATTERNS    = *.cc *.h
INCLUDE_PATH     = examples
TAGFILES         = qt.tag
SEARCHENGINE     = YES

若要從原始碼重新產生 Qt-1.44 文件,您可以使用以下設定檔

PROJECT_NAME         = Qt
OUTPUT_DIRECTORY     = qt_docs
HIDE_UNDOC_MEMBERS   = YES
HIDE_UNDOC_CLASSES   = YES
ENABLE_PREPROCESSING = YES
MACRO_EXPANSION      = YES
EXPAND_ONLY_PREDEF   = YES
SEARCH_INCLUDES      = YES
FULL_PATH_NAMES      = YES
STRIP_FROM_PATH      = $(QTDIR)/
PREDEFINED           = USE_TEMPLATECLASS Q_EXPORT= \
                       QArrayT:=QArray \
                       QListT:=QList \
                       QDictT:=QDict \
                       QQueueT:=QQueue \
                       QVectorT:=QVector \
                       QPtrDictT:=QPtrDict \
                       QIntDictT:=QIntDict \
                       QStackT:=QStack \
                       QDictIteratorT:=QDictIterator \
                       QListIteratorT:=QListIterator \
                       QCacheT:=QCache \
                       QCacheIteratorT:=QCacheIterator \
                       QIntCacheT:=QIntCache \
                       QIntCacheIteratorT:=QIntCacheIterator \
                       QIntDictIteratorT:=QIntDictIterator \
                       QPtrDictIteratorT:=QPtrDictIterator
INPUT                = $(QTDIR)/doc \
                       $(QTDIR)/src/widgets \
                       $(QTDIR)/src/kernel \
                       $(QTDIR)/src/dialogs \
                       $(QTDIR)/src/tools
FILE_PATTERNS        = *.cpp *.h q*.doc
INCLUDE_PATH         = $(QTDIR)/include
RECURSIVE            = YES

對於 Qt-2.1 的原始碼,我建議使用以下設定

PROJECT_NAME          = Qt
PROJECT_NUMBER        = 2.1
HIDE_UNDOC_MEMBERS    = YES
HIDE_UNDOC_CLASSES    = YES
SOURCE_BROWSER        = YES
INPUT                 = $(QTDIR)/src
FILE_PATTERNS         = *.cpp *.h q*.doc
RECURSIVE             = YES
EXCLUDE_PATTERNS      = *codec.cpp moc_* */compat/* */3rdparty/*
ALPHABETICAL_INDEX    = YES
IGNORE_PREFIX         = Q
ENABLE_PREPROCESSING  = YES
MACRO_EXPANSION       = YES
INCLUDE_PATH          = $(QTDIR)/include
PREDEFINED            = Q_PROPERTY(x)= \
                        Q_OVERRIDE(x)= \
                        Q_EXPORT= \
                        Q_ENUMS(x)= \
                        "QT_STATIC_CONST=static const " \
                        _WS_X11_ \
                        INCLUDE_MENUITEM_DEF
EXPAND_ONLY_PREDEF    = YES
EXPAND_AS_DEFINED     = Q_OBJECT_FAKE Q_OBJECT ACTIVATE_SIGNAL_WITH_PARAM \
                        Q_VARIANT_AS

這裡 Doxygen 的預處理器用於替換一些通常由 C 預處理器替換的巨集名稱,但不執行完整的巨集展開。

前往下一節或返回索引