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

Posted 2021-04-28

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

• 安装
• - 安装在macos上
• - 安装在窗户上
• - 在Linux上安装

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

我的install.md文件如下：

• @page安装
• @subpage macos
• @subpage窗口
• @subpage linux

并且“macos.md”，“windows.md”和“linux.md”都有自己的页面标题：例如@page macos，@ page windows和@page linux。

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

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

提前致谢。

答案

我寻找一个体面的解决方案的年龄，这是我发现：

在主markdown文件（此处为install.md）中，定义一个组，例如：

defgroup GrpDummyPages HiddenEmpty
@{
@}

然后在你的子页面中，为了你的'windows.md'，请在开头添加：

ingroup GrpDummyPages

在树视图中将出现一个“模块”部分，子类别为“隐藏空”，其中包含放置ingroup命令的页面/文件。

另一答案

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

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

使用@page可以工作，但它会在导航树中创建额外的空白页面。

一个例子......假设一个小的层次结构：

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

main.面对:

# Main Page {#mainpage}

This is text...

* subpage SubPage1

subpage1.面对:

# First Subpage Title {#SubPage1}

Some text for the subpage

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

---

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

SubPage1.md :(越野车）

@page SubPage1  

# First Subpage Title

Some text for the subpage