Doxygen：自定义示例页面

Question

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

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

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

运行Doxygen后，我会在导航中创建一个Examples页面，但是Examples部分总是如下所示：

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

如何更改此页面？我特别想要替换文本＆＃34;以下是所有示例的列表：＆＃34;有更大的介绍。

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

Answer 1

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

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

$ doxygen -l

通过编辑Doxyfile配置文件或使用Doxywizard GUI（专家选项卡 - ＆gt; Build - ＆gt; LAYOUT_FILE）将Doxygen更改为此文件，以将LAYOUT_FILE路径更改为新{{1}文件。

我建议明确执行此步骤，而不是依赖于默认行为，以便在运行Doxygen的文件夹中存在DoxygenLayout.xml时提取。

您需要修改DoxygenLayout.xml XML标记并更改现有的<tab type="examples">属性，并添加title属性以满足您的需求。 intro属性会更改页面标题的名称和HTML浏览器顶部的TAB名称，因此更短的内容更好。

例如：

title

产地：

  

ALI库示例

     

欢迎来到我为您准备的精彩实例。

     

  
• CSV-simple.tcl
  

请注意，我在正式的Doxygen文档中找不到有关 <tab type="examples" visible="yes" title="ALI Library Examples" intro="Welcome to the fantastic set of examples I have prepared for your enjoyment."/> 属性的任何信息。我在阅读文章Adding new user Tab in the Doxygen Layout时注意到了它。