使用Doxygen生成Markdown用户文档时如何消除空白页面

Question

5

目前我正在使用Doxygen从几个markdown文件生成用户文档。我想生成一个自定义的导航树，类似于以下内容:

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

我的"install.md"文件如下：

"macos.md"、"windows.md"和"linux.md"各自都有自己的页面标题：例如 @page macos，@page windows 和 @page linux。

结果很好，但它会生成一些空白页面，文件名为其对应的md文件名。

我该如何摆脱所有这些空白页文件？

提前致谢。

- 0owen

2个回答

-1

在doxygen 1.8.10中，这似乎是有效的：在.md文件中的标题后使用Header ID Attributes {#pageId}标记独占。

使用@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

- Louis Cyphre

嗨。对我来说，这也会在左侧树中放置一个名为SubPage1的页面。 - Napseis

@Napseis...很抱歉听到这个消息。您使用的是Doxygen 1.8.10（目前最新版本）吗？ - Louis Cyphre

我有Doxygen 1.8.9.1。 - Napseis

基本上，如果页面不是其他页面的@子页面，则它将出现在索引中。 - Louis Cyphre

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- Napseis · Accepted Answer

我花费了很长时间寻找一个好的解决方案，最终找到了这个：

在你的主要 Markdown 文件（例如 install.md）中定义一个组，例如：

\defgroup GrpDummyPages HiddenEmpty
@{
@}

接下来，在您的子页面中，例如您的“windows.md”页面，在开头添加：

\ingroup GrpDummyPages

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