Doxygen：自定义示例页面答案

【问题标题】：Doxygen: Customizing the Examples PageDoxygen：自定义示例页面
【发布时间】：2016-02-03 07:55:29
【问题描述】：

在使用 Doxygen 记录项目时，我遇到了以下问题。

我有一组示例程序（demo_1.c、demo_2.c、...），它们位于 Doxyfile 中的 EXAMPLE_PATH 集中。我创建了一个文件examples.c，其中包含以下内容以包含示例：

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

运行 Doxygen 后，会在导航中创建我想要的示例页面，但示例部分始终如下所示：

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

如何更改此页面？我特别想用更大的介绍替换文本“Here is a list of all examples:”。

我已经生成了 doxygen 布局文件和页眉/页脚文件，但这并没有给我任何有用的信息。

【问题讨论】：

我也有这个问题。实际上，创建 Markdown 文件比使用内置的示例列表支持更容易/更好。

标签： doxygen

【解决方案1】：

解决方案是创建一个DoxygenLayout.xml 文件并使用您希望在示例页面上显示的信息对其进行自定义。

Doxygen 将通过以下命令行根据当前使用的配置在当前目录中生成一个模板 XML 文件：

$ doxygen -l

通过编辑 Doxyfile 配置文件或使用 Doxywizard GUI（专家选项卡 -> 构建 -> LAYOUT_FILE）将 LAYOUT_FILE 路径更改为新的 DoxygenLayout.xml 文件，将 Doxygen 指向此文件。

我建议明确地执行此步骤，而不是依赖默认行为来获取运行 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时注意到了这一点。

【讨论】：