Doxygen:自定义示例页面
在使用Doxygen记录项目时,我遇到了以下问题 我有一组示例程序(demo_1.c、demo_2.c等),它们位于doxy文件中设置的Doxygen:自定义示例页面,doxygen,Doxygen,在使用Doxygen记录项目时,我遇到了以下问题 我有一组示例程序(demo_1.c、demo_2.c等),它们位于doxy文件中设置的example_路径中。我创建了一个文件examples.c,其中包含以下内容以包括示例: /** * \example demo_1.c * \example demo_2.c * ... */ 运行Doxygen后,将在导航中创建一个示例页面(如我所愿),但示例部分始终如下所示: Examples -------- Here is a lis
example_路径中。我创建了一个文件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
如何更改此页?我特别想用一个更大的介绍来替换“这里是所有示例的列表”这一文本
我已经生成了doxygen布局文件和页眉/页脚文件,但这没有给我任何有用的信息。解决方案是创建一个文件,并使用希望显示在示例页面上的信息对其进行自定义
Doxygen将通过以下命令行从当前使用的配置在当前目录中生成一个模板XML文件:
$ doxygen -l
通过编辑Doxyfile
配置文件或使用Doxywizard GUI(专家选项卡->构建->布局文件)将LAYOUT\u文件的路径更改为新的DoxygenLayout.xml
文件,将Doxygen指向此文件
我建议显式地执行此步骤,而不是依赖默认行为来拾取运行Doxygen的文件夹中的DoxygenLayout.xml
您需要编辑
XML标记,更改现有的title
属性,并添加intro
属性以满足您的需要。title
属性会更改页面标题的名称以及HTML浏览器顶部的选项卡名称,因此越短越好
例如:
<tab type="examples" visible="yes" title="ALI Library Examples" intro="Welcome to the fantastic set of examples I have prepared for your enjoyment."/>
产生:
阿里图书馆实例
欢迎来到我为您准备的精彩示例集
- csv-simple.tcl
注意,我在正式的Doxygen文档中找不到任何关于intro
属性的信息。我在阅读文章时注意到了这一点。解决方案是创建一个文件,并使用希望出现在示例页面上的信息对其进行自定义
Doxygen将通过以下命令行从当前使用的配置在当前目录中生成一个模板XML文件:
$ doxygen -l
通过编辑Doxyfile
配置文件或使用Doxywizard GUI(专家选项卡->构建->布局文件)将LAYOUT\u文件的路径更改为新的DoxygenLayout.xml
文件,将Doxygen指向此文件
我建议显式地执行此步骤,而不是依赖默认行为来拾取运行Doxygen的文件夹中的DoxygenLayout.xml
您需要编辑
XML标记,更改现有的title
属性,并添加intro
属性以满足您的需要。title
属性会更改页面标题的名称以及HTML浏览器顶部的选项卡名称,因此越短越好
例如:
<tab type="examples" visible="yes" title="ALI Library Examples" intro="Welcome to the fantastic set of examples I have prepared for your enjoyment."/>
产生:
阿里图书馆实例
欢迎来到我为您准备的精彩示例集
- csv-simple.tcl
注意,我在正式的Doxygen文档中找不到任何关于intro
属性的信息。我在阅读文章时注意到了这一点。我也有这个问题。实际上,创建标记文件比使用内置的示例列表支持更容易/更好。我也有这个问题。实际上,创建标记文件比使用内置的示例列表支持更容易/更好。