Doxygen的：自定義示例Page

Question

雖然記錄與Doxygen的一個項目，我遇到了以下問題。

我有一套示例程序（demo_1.c，demo_2.c，...），它位於EXAMPLE_PATH內部，設置在Doxyfile中。我創建了一個文件examples.c與下列內容包括例子：

Examples 
-------- 
Here is a list of all examples: 
* demo_1.c 
* demo_2.c 

：

/** 
* \example demo_1.c 
* \example demo_2.c 
* ... 
*/ 

運行Doxygen的，一個例子頁面導航中創建的，因爲我想它，但實例部分總是看起來像後

我該如何改變這個頁面？我特別想用一個更大的介紹來替換文本「這裏是所有例子的列表：」。

我已經生成doxygen的佈局文件和頁眉/頁腳文件，但這並沒有給我任何有用的信息。

Answer 1

的解決方案是創建一個DoxygenLayout.xml文件，並希望出現的例子頁面上的信息進行定製。

Doxygen的將產生一個模板XML文件，在當前目錄中，從它當前正在使用通過以下命令行配置：通過編輯Doxyfile配置文件或使用

$ doxygen -l 

點的Doxygen到該文件在Doxywizard GUI（專家選項卡 - >構建 - > LAYOUT_FILE）到LAYOUT_FILE路徑更改爲新DoxygenLayout.xml文件。

我建議做這一步明確，而不是依賴於默認行爲皮卡時的Doxygen從運行的文件夾中存在，它的DoxygenLayout.xml。

您將需要編輯<tab type="examples"> XML標記並更改現有的title屬性並添加intro屬性以滿足您的需要。 title屬性會更改頁面上標題的名稱和HTML瀏覽器頂部的TAB名稱，所以縮短更好。

例如：

<tab type="examples" visible="yes" title="ALI Library Examples" intro="Welcome to the fantastic set of examples I have prepared for your enjoyment."/> 

產地：

ALI圖書館例子

歡迎來到奇妙一套我已經爲你準備享受例子。

• CSV-simple.tcl

注意，我找不到任何有關正式Doxygen文檔中intro屬性的任何信息。我在閱讀文章Adding new user Tab in the Doxygen Layout時注意到了這一點。