使用 doxygen 的 \link 命令

发布于 2024-11-10 06:54:16 字数 631 浏览 3 评论 0原文

我有一个外部 HTML 文件,我想从我的 doxygen“相关页面”选项卡或左侧框架中链接。看来我需要使用 \link 命令,但我找不到如何使用它或在哪里使用它的好例子。我目前正在使用 doxywizard 来生成 HTML。

那么,\link 是我合并到我的 doxygen 配置文件中还是在我以某种方式构建 HTML 时添加它?

更新

因此,我最终必须执行以下操作:

  1. 创建一个包含以下内容的新页面 (docs_main.html):

    <前><代码>/*! \主页我的标题在这里 * \section intro_sec 外部资源 * 我的外部页面 */
  2. 将该页面包含在我的 doxygen 包含文件列表中

  3. 重建我的文档

将以下内容添加到我的 doxygen“主页”中

MY TITLE HERE

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

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.

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

Update

So I ended up having to do the following:

  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>
     */
    
  2. Include that page in my doxygen included files list

  3. Rebuild my documentation

That added to my doxygen "Main Page" the following

MY TITLE HERE

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

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(5

迷途知返 2024-11-17 06:54:16

现在,我们在 doxygen 中提供了 Markdown 支持。您的代码可能更清晰:

/*! \mainpage MY TITLE HERE
 * \anchor intro_sec
 * # External resources
 * [My external page](http://link_to_my_external_page.html)
 */

上面的内容应该呈现得有点接近:


外部资源

我的外部页面


We have a Markdown support in doxygen nowadays. Your code may be a clearer:

/*! \mainpage MY TITLE HERE
 * \anchor intro_sec
 * # External resources
 * [My external page](http://link_to_my_external_page.html)
 */

The above should render somewhat close to:


External resources

My external page


我一向站在原地 2024-11-17 06:54:16

Doxygen 允许您在文档中插入某些 HTML 命令,包括链接。如果您不知道如何在 HTML 中创建链接:

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

cdiggins的回答也值得一读。

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' answer is also worth reading.

记忆で 2024-11-17 06:54:16

\link(以及 \command 或 @command 形式的任何内容)称为“特殊命令”,是 Doxygen 处理的输入文件中使用的标记的一部分,而不是配置的一部分。 \link 命令 不执行您想要的操作。

您也许可以使用 \page 命令 创建一个新的相关页面,然后使用 \htmlinclude 命令 插入外部 HTML 文件作为该文件的内容页。

The \link (and anything of the form \command or @command) is called a "special command" and is part of the mark-up used in the input files processed by Doxygen not part of the configuration. The \link command does not do what you want.

You could perhaps use the \page command to create a new related page and then use the \htmlinclude command to insert the external HTML file as the contents of that page.

和影子一齐双人舞 2024-11-17 06:54:16

由于这里的其他答案对于初学者来说看起来是零碎的,所以这里是完整的过程。

1) 创建一个 html 文件,其内容(例如:abc.html)如下

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

2) 在此配置文件中添加此文件路径
<代码>
输入=

3)同时在此处添加您的文件类型
<代码>
文件模式=

上述过程在 doxygen 窗口中打开文件

添加以下内容以在资源管理器中打开文件

我的外部页面< ;/b>

注意:如果文件未打开,请尝试提供绝对路径

As other answers here looks bits and pieces for a beginner, here is the complete procedure.

1) create an html file with content(ex:abc.html) as below

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

2) Add this file path in config file here

INPUT =

3)Also add your file type here

FILE_PATTERNS =

The above procedure opens your file in doxygen window

Add the below content to open the file in explorer

<a href="link_to_my_external_page.html" target="_blank"><b>My external page</b></a>

Note: If file doesn't open try giving absolute path

吻风 2024-11-17 06:54:16

您可以使用自定义布局文件将选项卡添加到主导航栏(带有链接)。

查看 Doxygen 手册的自定义输出页面。假设我理解你的问题,那么如何做就很清楚了。

You can add a tab to the main navigation bar (with your link) by using a custom layout file.

Take a look at the Customizing the Output page of the Doxygen manual. It's pretty clear about how to do it, assuming I understood your question.

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文