我正在我的应用程序中编写一些模块的概述文档。我主要使用\page
,\subpage
,\section
和\subsection
标记。
\page
和\subpage
标签允许我为文档提供一个很好的层次结构,它在网页的标题中清晰可见,或者用于构建目录时使用QHelpGenerator转换为Qt帮助。因此,我知道页面应该有唯一的名称。
当我在我的页面中给出我的部分名称,例如'overview','introduction','section1','section2'等等,当我构建我的文档的子集时,它似乎正常工作。似乎节名不必是唯一的。
但是,当我构建一组更大的文档文件时,某些页面不再正确创建。这可能是由非全局唯一的部分名称引起的吗?
我试图找到有关节名称的全局唯一性的信息,但我找不到有关节名称唯一性的任何声明。他们必须具有全球独特性吗?
修改 我现在注意到,如果一个文件有一个ID为X和标题为A的部分,另一个文件的部分为id X和标题B,那么它们在生成的文档(A或B)中都会得到相同的标题。所以这似乎表明id应该是全局唯一的。有没有办法规避这个?
答案 0 :(得分: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