4

doxygenのドキュメントにカスタムコマンドを追加したいと思います。基本的に、ドキュメントを作成しているC関数ごとに、読み取りモードまたは書き込みモードで「タッチ」されるグローバル変数を作成する必要があります。「関連項目」リストのようなものですが、キャプションが異なります。

私のファイルには、次のようなものを書きたいと思います。

/*
 * \read-globals   #var1, #var2
 *
 * \write-globals  #var3
 */

私はこのようなエイリアスで試しました:

read-globals = \par <b>Globals read</b>\n

それは機能しますが、スタイルシートに依存しないのではないかと心配しています。明日cssを変更したい場合、このカスタムコマンドは、seealso、author、および他のすべてのセクションとは異なる出力を生成します。

基本的には、他の標準コマンドからフォーマットをコピーしたいだけです。

もう1つのオプションは、\ xrefitemコマンドを使用することです。これも機能しますが、私の場合はまったく役に立たない2番目のパラメーターとしてセクションを導入する必要があります(おそらくそれを非表示にすることができますか?)。

私の目標を達成するための「正しい方法」はありますか?

4

1 に答える 1

4

2番目のパラメータを非表示にする場合は\xrefitem、を組み合わせることができます。ALIASESこれが私が要件に使用する例です:

ALIASES += "req=\xrefitem req \"Requirement\" \"Requirements\" "

次に、文書化されたコードで:

/// \req #42 The system shall work in any situation

(その質問に対する私の答えから:Doxygenを使用したカスタムタグ

于 2009-10-30T15:10:22.533 に答える