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

时间:2016-12-16 00:19:25

标签: documentation markdown doxygen documentation-generation

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

README.md

# This is the main page.

Main Page contents.

维基/ 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属性中。

1 个答案:

答案 0 :(得分: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"/>
    
  4. 标准文件名转换为md_{path_to_markdown_without_extension}.html