【问题标题】:How to get ride of a empty page when using Doxygen to generate markdown user documentation使用 Doxygen 生成 Markdown 用户文档时如何摆脱空白页面
【发布时间】:2014-04-13 16:12:55
【问题描述】:

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

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

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

我的 install.md 文件如下:

  • @page 安装
  • @subpage 宏
  • @子页面窗口
  • @subpage linux

并且 "macos.md" 、 "windows.md" 和 "linux.md" 都有自己的页面标题: 如@page macos、@page windows 和@page linux。

效果很好,但是生成了几个带有文件名的空白页面。

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

提前致谢。

【问题讨论】:

    标签: doxygen


    【解决方案1】:

    我找了很长时间才找到一个不错的解决方案,这就是我发现的:

    在你的主markdown文件(这里是install.md)中,定义一个组,例如:

    \defgroup GrpDummyPages HiddenEmpty
    @{
    @}
    

    然后在您的子页面中,例如您的“windows.md”,在开头添加:

    \ingroup GrpDummyPages
    

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

    【讨论】:

      【解决方案2】:

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

      Doxygen 文档: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
      

      【讨论】:

      • 嗨。对我来说,这也会在左侧树中放置一个名为 SubPage1 的页面。
      • @Napseis ...我很遗憾听到这个消息。您使用的是 Doxygen 1.8.10(目前最新版本)吗?
      • 我有 Doxygen 1.8.9.1
      • 基本上,如果页面不是其他东西的@Subpage,它就会出现在索引中。
      猜你喜欢
      • 2021-12-18
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2013-11-11
      • 2014-05-01
      • 2015-09-04
      相关资源
      最近更新 更多