使用doxygen的\link命令 [英] Use of doxygen's \link command

问题描述

我有一个外部HTML文件，我想通过doxygen的相关页面标签或左侧框架进行链接。看来我需要使用 \link 命令，但找不到如何使用它或在何处使用的好例子。我当前正在使用doxywizard生成HTML。

I have an external HTML file I'd like to have linked form either my doxygen "Related Pages" tab or the left hand frame. It seems I need to use the \link command but I can't find a good example of how to use it or where. I am currently using doxywizard to generate the HTML.

因此， \link 是我整合到doxygen中的东西吗？配置文件还是在以某种方式构建HTML时添加它？

So, is \link something I incorporate into my doxygen config file or do I add it when I build the HTML somehow?

更新

所以我最终不得不执行以下操作：

So I ended up having to do the following:

1. 创建一个具有以下内容的新页面（docs_main.html） ：

1. Create a new page (docs_main.html) that had the following:

/*! \mainpage MY TITLE HERE
 * \section intro_sec External resources
 * <a href="link_to_my_external_page.html">My external page</a>
 */

将该页面包含在我的包含doxygen的文件列表中

Include that page in my doxygen included files list

重建我的文档

主页以下内容

MY TITLE HERE

My external page (which was a link to that page)

推荐答案

Doxygen允许您插入您的文档（包括链接）中的某些HTML命令。如果您不知道如何使用HTML进行链接：

Doxygen allows you to insert certain HTML commands in to your documentation, including links. In case you didn't know this is how you make a link in HTML:

<a href="externalfile.html">External file</a>

cdiggins的答案也值得一读。

这篇关于使用doxygen的\link命令的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！