6

テンプレートのオーバーロードを使用していくつかの関数を文書化しており、特定のオーバーロードを参照したいと考えています。\refしかし、コマンドが理解するために署名を正確に入力する方法がわかりません。残念ながら正規版が必要ですが、私にはわかりません。doxygen が生成した正規署名のリストを取得する方法はありますか?

私の特定のケースは、次のように宣言された関数です。

template <typename T, size_t S>
int function(T value, Table const (&descriptors)[S]);

私はもう試した

\ref function(T,Table(&)[])
\ref function<>(T,Table(&)[])
\ref function(T,const Table(&)[])
\ref function<>(T,const Table(&)[])
\ref function(T,Table const(&)[])
\ref function<>(T,Table const(&)[])

そして、私もなしで試してみました\ref（シンボルを自動的に認識するはずです）が、それは良くありませんでした.

または、参照を自分で定義する方法はありますか?

また、ターゲット関数のドキュメントでアンカーを定義しようとしましたが、関数への参照としてヘッダーではなく、説明の本文を指しています。

4

1 に答える 1

3

doxygen のバグにより、中括弧を含む型のパラメーターを @ref'ing することができませんでした。可能な解決策を GitHubにコミットしました。それがうまくいくかどうか教えてください。

次の例を使用して、自分でテストしました。

/** @file */

/** complex function */
template <typename T, size_t S>
int function(T value, Table const (&descriptors)[S]);

/** @mainpage
 *  See @ref function(T,Table const (&)[S]) "complex function" for details.
 */
于 2013-09-09T10:00:33.277 に答える