问题描述
|
我有一个外部HTML文件,我想通过doxygen的“相关页面”标签或左侧框架进行链接。似乎我需要使用
\\link
命令,但找不到如何使用它或在何处使用的好示例。我目前正在使用doxywizard生成HTML。
那么,是\\link
是我合并到doxygen配置文件中的东西,还是在构建HTML时添加了它?
更新资料
因此,我最终不得不执行以下操作:
创建一个具有以下内容的新页面(docs_main.html):
/*! \\mainpage MY TITLE HERE
* \\section intro_sec External resources
* <a href=\"link_to_my_external_page.html\">My external page</a>
*/
将该页面包括在我的包含doxygen的文件列表中
重建我的文件
在我的doxygen \“ Main Page \”中添加了以下内容
MY TITLE HERE
My external page (which was a link to that page)
解决方法
Doxygen允许您在文档中插入某些HTML命令,包括链接。如果您不知道这是如何在HTML中建立链接:
<a href=\"externalfile.html\">External file</a>
cdiggins的答案也值得一读。
, 如今,我们在Doxygen中提供Markdown支持。您的代码可能更清晰:
/*! \\mainpage MY TITLE HERE
* \\anchor intro_sec
* # External resources
* [My external page](http://link_to_my_external_page.html)
*/
上面的内容应该接近:
外部资源
我的外部页面
, \\ link(以及任何形式的\\ command或@command)被称为\“特殊命令\”,并且是Doxygen处理的输入文件中使用的标记的一部分,而不是配置的一部分。 \\ link命令不会执行您想要的操作。
您也许可以使用\\ page命令创建一个新的相关页面,然后使用\\ htmlinclude命令插入外部HTML文件作为该页面的内容。
, 正如这里的其他答案对于初学者来说有些零碎一样,这里是完整的过程。
1)创建一个具有content(ex:abc.html)的html文件,如下所示
/*! \\mainpage MY TITLE HERE
* \\section intro_sec External resources
* <a href=\"link_to_my_external_page.html\">My external page</a>
*/
2)在此处将此文件路径添加到配置文件中
INPUT =
3)也在这里添加您的文件类型
FILE_PATTERNS =
上面的过程在doxygen窗口中打开文件
添加以下内容以在资源管理器中打开文件
<a href=\"link_to_my_external_page.html\" target=\"_blank\"><b>My external page</b></a>
注意:如果文件无法打开,请尝试提供绝对路径
, 您可以使用自定义布局文件将选项卡添加到主导航栏(带有链接)。
查看Doxygen手册的“定制输出”页面。假设我了解您的问题,那么如何做就很清楚了。