2013-09-04 3 views
5

いくつかの関数をテンプレートオーバーロードで文書化しており、特定のオーバーロードを参照したいと考えています。しかし、私は正確に\refコマンドの署名を入力する方法を知りません。それは残念なことに標準バージョンを必要とし、私はそれを知らない。 は、正規の署名doxygenのリストを生成する方法はありますか?複雑なシグネチャを持つものへの正しいdoxygen参照を見つけるにはどうすればよいですか?

私の特定の場合は次のように宣言された関数である:私は

\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(&)[]) 

を試してみた

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

そして、私は(自動的にシンボルに気づくことになっています)あまりにも\refずに試してみました、しかし、それは良くありませんでした。

自分自身でリファレンスを定義する方法がありますか?ですか?

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

+0

'S'は、ソリューションの一部でなければなりません。 – Jarod42

答えて

2

doxygenのバグにより、タイプが中かっこを含む@ ref'ingパラメータが無効になりました。 私はちょうどcommitted 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. 
*/ 
関連する問題