2

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

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

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

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

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

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

4

1 回答 1

2

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
于 2012-12-09T07:36:12.043 回答