@ref参照の終わりはどうですか？

Question

私はC++コードを文書化するためにDoxygenを使用していますが、そのコードに相当量のDoxygen docを書いています。一つの場所では、私は、コード内のグループのリストを作ってるんだ、と次のように表示させたいと思います：

• Control Module：すべて
• Slave Moduleを制御するモジュール：スレーブでのモジュールをControl Module

のマイドキュメントのソースは、次のようになります。

- CM @ref： - ：@CMのスレーブ

しかし、問題となっているモジュール：DoxygenのはCM:として参照名を読んでいるように見える、SM @refすべて
を制御するモジュールCMではないため、参照を見つけることができません。だから、どうにかして参照名が終わるDoxygenに伝える必要があります。 （たとえば、私がBashを使用していて、 "s"を接尾辞として使用して可変文字列をエコーし​​たい場合は、echo "${NOUN}s"を使用します）。

回避策として、名前と後続のコロンですが、結果として得られたドキュメントは読みにくくなり、私はそれを避けたいと思います。

はSpecial Commandsの下では、Doxygenのマニュアルは、次の希望に満ちた響きの情報が含まれています

一部のコマンドは、1つ以上の引数を持っています。

• <シャープ>中括弧を使用する場合は、引数1つの単語である：各引数は、特定の 範囲を持っています。
• （丸い）中かっこが使用されている場合、引数は、コマンドが見つかった の行の終わりまで拡張されます。
• {curly}の中かっこが使用されている場合、引数 は次の段落まで続きます。段落は、ブランク 行またはセクションインジケータで区切られます。

OK、それはすべての罰金と良いですが、ドキュメントは言っていない、と私は理解できない、これらのブレースが行くことになっている。議論の周りのみ？コマンドと議論全体の周りに？どちらもうまくいかず、私は働く代わりの方法を考え出すことができません。

したがって、参照名の末尾をDoxygenに指定するにはどうすればよいですか？中括弧が答えの場合、どこに行くのですか？あなたが引用

Answer 1

Doxygenのドキュメントは、Doxygenのの使用によって解析される源の、Doxygenのドキュメントの構文はない記述しています。

つまり、<シャープ>の場合は、コマンドの説明に中カッコが使用されています。等々。

@refのドキュメントを見て：

\ref <name> ["(text)"] 

name引数は "シャープな中括弧" であるので、それだけで一つの単語です。残念ながら、Doxygenはその単語の一部として:を解釈しているようです。あなたの最善の策は、スペースを導入することになります。

@ref CM : the ... 

あなたはまた、ゼロ幅文字が単語認識を破るかどうかを試すことができます：

@ref CM‌: the ... 

Answer 2

これはDoxygenのバージョン1.8.11のために働く：

\ref name "": 

明らかに空の文字列は、その前にname引数を使用するフォールバックをトリガーします。