使用Doxygen生成markdown用户文档时如何获取空白页面

时间:2014-04-13 16:12:56

标签: doxygen

目前我正在使用Doxygen从几个markdown文件生成用户文档。 我想生成如下所示的自定义导航树:

  • 安装
  • - 在macos上安装
  • - 在Windows上安装
  • - 在linux上安装

我这里有4个降价页面。假设它们是“install.md”,“macos.md”,“windows.md”和“linux.md”。

我的install.md文件如下:

  • @page install
  • @subpage macos
  • @subpage windows
  • @subpage linux

和“macos.md”,“windows.md”和“linux.md”都有自己的页面标题: 例如@page macos,@ page windows和@page linux。

结果非常好,但它会生成一些带有文件名的空页。

我怎么能摆脱所有这些空页面文件?

提前致谢。

2 个答案:

答案 0 :(得分:1)

我找了一个体面的解决方案的年龄,这就是我发现的:

在主要降价文件(此处为install.md)中,定义一个组,例如:

\defgroup GrpDummyPages HiddenEmpty
@{
@}

然后在您的子页面中,对于您的' windows.md',请在开头添加:

\ingroup GrpDummyPages

在您的树状视图中,将显示一个'模块'部分,包含子类别' HiddenEmpty',它将包含您放置ingroup命令的页面/文件。

答案 1 :(得分:-1)

使用doxygen 1.8.10,这似乎有效:在.md文件中的标题之后使用标题ID属性{#pageId}标记。

Doxygen doc:http://www.doxygen.nl/manual/markdown.html#md_header_id

使用@page有效,但它会在导航树中创建额外的空白页面。

一个例子......假设有一点层次结构:

Main.md
   SubPage1       (Subfolder)
   SubPage1.md    (File in Subfolder)

Main.md:

# Main Page {#mainpage}

This is text...

* \subpage SubPage1

SubPage1.md:

# First Subpage Title {#SubPage1}

Some text for the subpage

层次结构将在生成的TreeView中表示,您可以根据需要嵌套页面。

以下演示了问题..它将创建额外的空页...

SubPage1.md :(越野车)

@page SubPage1  

# First Subpage Title

Some text for the subpage