如何将Markdown文件指定为Doxygen中的另一个选项卡?

问题描述 投票:1回答:1

考虑具有以下两个文件的项目。请注意,OtherTab.md位于子目录中。

README.md

# This is the main page.

Main Page contents.

wiki/OtherTab.md

# This is another tab

Contents for another tab.

现在,我运行Doxygen -g来生成一个Doxyfile。我将以下几行添加到Doxyfile

USE_MDFILE_AS_MAINPAGE = README.md
INPUT                  = . wiki

我想在Wiki选项卡旁边添加一个名为Main Page的选项卡,该选项卡指向文件wiki/OtherTab.md

我怎么能做到这一点?

我看过this questionthis documentation,但是没有解决如何在Doxygen中实际创建新选项卡的问题,并将其指向通过处理特定Markdown文件生成的html。

另外,我试图将this answer用于我之前的问题,但不确定将什么放入url标签的tab属性中。

documentation markdown doxygen documentation-generation
1个回答
0
投票

出现了一些实验,似乎有一个标准的转换应用于Markdown文件的名称。

因此,以下步骤将创建一个指向Markdown文件的新选项卡。

  1. 使用doxygen -l生成布局文件。
  2. 在Doxyfile中设置LAYOUT_FILE = DoxygenLayout.xml
  3. DoxygenLayout.xml文件中,添加以下选项卡。 <tab type="user" visible="yes" url="md_wiki_OtherTab.html" title="Wiki"/>

标准文件名转换是md_{path_to_markdown_without_extension}.html

© www.soinside.com 2019 - 2024. All rights reserved.