額外文件

自訂頁面

Doxygen 也可用於建立不屬於程式庫/程式 API 的自訂頁面。這些頁面的目的是使用您認為使用者可能會覺得有用的任何其他內容來豐富您的文件。

若要建立自訂頁面,請使用其中一種支援的副檔名:.dox.txt.md。Doxygen 會將 .dox 或 .txt 檔案視為 C/C++ 原始檔,而 .md 檔案則視為 Markdown 檔案。

對於 .dox 或 .txt 檔案,可以使用單個 Doxygen 註解,如下所示

manual/index.dox

/** \mainpage 我的程式庫手冊
- 建置
- 基本概念
- 範例
*/

您會注意到使用了 \mainpage 命令,這會告訴 Doxygen 將此頁面用作主要頁面。對於其他頁面,請在它們前面加上 \page 命令。

預設情況下,Doxygen 不會知道這些自訂檔案,因此我們需要透過 Doxyfile 中的 INPUT 屬性來告知它。對於上述範例,請將此行新增至您的 Doxyfile

INPUT = manual/index.dox

接下來,我們可能想新增有關如何建置專案的說明,因此我們建立 manual/building/index.dox。當您閱讀更多文件時,您會發現 Doxygen 支援 HTML 標籤的子集,因此我們可以撰寫以下內容

/** \page 建置
<h2>Linux</h2>
<p>
建置此專案的簡單方法是使用 cmake,複製儲存庫,cd 到專案的根目錄並執行
</p>
<pre>
<code>
mkdir my_build
cmake -S . -B my_build
cd my_build
cmake --build .
</code>
</pre>
*/

但是您當然也可以使用常用的 Markdown 標記法來執行相同的操作

# Building

## Linux

A simple way to build this project is with cmake, clone the repository,
cd into the root of the project and run:

    mkdir my_build
    cmake -S . -B my_build
    cd my_build
    cmake --build .

擴展規模

自動加入檔案

此時,我們現在可以使用逗號分隔符號將 manual/building/index.dox 新增至我們的 INPUT,但是隨著我們建立手冊,這可能會隨著時間的推移而變得麻煩,相反地,我們只會變更它以參考我們的手冊資料夾

INPUT = manual/

並設定

RECURSIVE = YES

以確保當我們建立更多組織和內容時,加入手冊的任何子目錄。

側邊面板樹狀檢視

隨著手冊的擴展,您可能還想擁有一個漂亮的樹狀檢視,以顯示您在手冊中的位置以保持井然有序。這很容易設定,使用以下命令開啟它

GENERATE_TREEVIEW = YES

在您的 Doxyfile 中。

您會記得我們的 manual/index.dox 檔案非常乏味,沒有任何指向任何地方的連結,透過使用 \ref 命令,我們可以在各個主題之間新增連結,這樣做將會自動開始填入我們的樹狀檢視。

如果您注意到您的樹狀結構更像是一堆樹葉,那麼您可以透過查看 子頁面 來解決此問題。

此討論應為您提供一些關於如何建立可擴展手冊以豐富您的文件的方向,從這裡您可能想要自訂您的 版面配置