0

\saorと同様に動作するエイリアスを定義したいと思います\see。たとえば、それでマークされた後続の段落を 1 つのセクションにグループ化し、各項目を 1 行にリストします。

例えば

\foo One
\foo Two
\foo Three

最終的には

Foo:
  One
  Two
  Three

簡単に言えば、同じように動作する\seeがラベルが異なるエイリアスです。

4

1 に答える 1

3

コマンドを見てください\xrefitem。doxygenのドキュメントから（強調鉱山）：

このコマンドは、\todoやなどのコマンドを一般化したものです\bug。発生場所と生成される関連ページとの間で自動的に相互参照されるユーザー定義のテキスト セクションを作成するために使用できます。関連ページでは、同じタイプのすべてのセクションが収集されます。

ドキュメントの例では、エイリアスを配置することをお勧めします

ALIASES += "reminder=\xrefitem reminders \"Reminder\" \"Reminders\""

構成ファイルで。次に、次のようなものを書きます

\reminder test 1
\reminder test 2
\reminder test 3

ドキュメントでは、次のような結果になります。

Reminder:  
   test 1  
   test 2  
   test 3

これに関する唯一の問題は、「リマインダー」と呼ばれる「関連ページ」タブの下に追加のページが表示されることです。この関連ページが必要ない場合は、カスタム コマンドのドキュメントに記載されているようにエイリアスを使用できます。

ALIASES += sideeffect="\par Side Effects:\n"

これにより、ドキュメントにコマンドを配置できるようになり、見出しSide Effects:\sideeffectを持つユーザー定義の段落が作成されます。ただし、これらは最終ドキュメントではグループ化されません (つまり、それぞれがSide Effects:見出しを生成します)。\sideeffect

于 2012-06-01T14:34:44.467 に答える