2

私は自分のアプリケーションのモジュールの概要ドキュメントを書いています。私は主に\page、、、\subpageおよび\sectionタグ\subsectionを使用します。

\pageandタグを使用すると、ドキュメントに優れた階層構造を与えることができます。\subpageこれは、Webページのヘッダーで明確に視覚化されるか、QHelpGeneratorを使用してQtヘルプに変換されるときに目次を作成するために使用されます。したがって、ページには一意の名前を付ける必要があることを理解しています。

ページ内のセクションに「概要」、「はじめに」、「セクション1」、「セクション2」などの名前を付けると、ドキュメントのサブセットを作成するときに正しく機能するようです。セクション名は一意である必要はないようです。

しかし、より大きなドキュメントファイルのセットを作成すると、一部のページが正しく作成されなくなります。これは、グローバルに一意ではないセクション名が原因である可能性がありますか？

セクション名のグローバルな一意性に関する情報を見つけようとしましたが、セクション名の一意性に関するステートメントが見つかりません。それらはグローバルに一意である必要がありますか？

編集： 1つのファイルにID XとタイトルAのセクションがあり、別のファイルにID XとタイトルBのセクションがある場合、生成されたドキュメント（AまたはB）で両方が同じタイトルを取得することに気付きました。したがって、これはIDがグローバルに一意である必要があることを示しているようです。これを回避する方法はありますか？

4

1 に答える 1

2

doxygenのセクション名は、グローバルに一意であることが意図されています。\refこれにより、ドキュメントの任意の部分からセクションを参照（ ）できます。

セクション見出し（IDが使用されていない/重要でない場合）のみを探している場合は、Doxygenが提供するヘッダーを指定するための他のメカニズムの1つに依存できます。次に例を示します。

  • ヘッダーに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 に答える