【问题标题】:Do section names have to be globally unique in Doxygen?在 Doxygen 中,部分名称是否必须是全局唯一的?
【发布时间】:2012-12-09 15:36:12
【问题描述】:

我正在为我的应用程序中的模块编写一些概述文档。我主要使用\page\subpage\section\subsection标签。

\page\subpage 标签允许我为文档提供一个很好的层次结构,它在网页的标题中清晰可见,或者在转换为 Qt 帮助时用于构建目录使用 QHelpGenerator。因此,我知道这些页面应该有唯一的名称。

当我在页面中为我的部分命名时,例如“概述”、“简介”、“部分 1”、“部分 2”等,当我构建文档的子集时,它似乎可以正常工作。似乎部分名称不必是唯一的。

但是,当我构建更大的文档文件集时,某些页面不再正确创建。这可能是由不是全局唯一的部分名称引起的吗?

我试图查找有关部分名称的全局唯一性的信息,但我找不到任何有关部分名称唯一性的声明。它们必须是全球唯一的吗?

编辑: 我现在注意到,如果一个文件有一个 id X 和标题 A 的部分,而另一个文件有一个 id X 和标题 B 的部分,它们在生成的文档(A 或 B)中都得到相同的标题。所以这似乎表明 id 应该是全球唯一的。有没有办法绕过这个?

【问题讨论】:

    标签: documentation doxygen


    【解决方案1】:

    doxygen 中的部分名称旨在全球唯一。这允许从文档的任何部分引用 (\ref) 部分。

    如果您只是在寻找部分标题(其中 id 不使用/不重要),您可以依赖其他机制之一来指定 Doxygen 提供的标题,例如:

    • 对标题使用 HTML 标记:

      <h1>Header 1</h1>
      <h2>Header 2</h2>
      <h3>Header 3</h3>
      
    • 使用标头的 Markdown 表示(假设启用了 Markdown 支持):

      Header 1
      ========
      
      Header 2
      --------
      

      # Header 1
      ## Header 2
      ### Header 3
      

    【讨论】:

    • Markdown 自 1.8.0 起支持 Doxygen
    猜你喜欢
    • 1970-01-01
    • 2011-07-27
    • 1970-01-01
    • 1970-01-01
    • 2018-07-03
    • 2015-08-19
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多