以前に Javadoc でドキュメントを作成し、説明でタグまたはおよびを使用して@see
、他のクラスにリンクしました。doxygen を試してみましたが、これらのタグには互換性がないようです。doxygen を実行すると、完全なタグは単純に通常のテキストとして解釈されます。@link
{@see foo}
{link foo}
同じ機能を得るために使用できる代替タグはありますか?
他のクラスにリンクするには、ref
コマンドを使用する必要があります。コマンドを使用できますが\link
、リンクテキストをコマンドで終了する必要があります\endlink
。これが問題であると思われます(ただし、ドキュメントの例がないと確信が持てません)。
自動リンクに関する doxygen マニュアル セクションから、クラスへのリンクに関する段落があります。
文書化されたクラスに対応し、少なくとも 1 つの小文字以外の文字を含む文書内のすべての単語は、クラスの文書を含むページへのリンクに自動的に置き換えられます。文書化されたクラスに対応する単語がリンクに置き換えられないようにしたい場合は
%
、単語の前に a を付ける必要があります。すべて小文字の記号にリンクするには、 を使用します\ref
。
さらに考慮すべき点がいくつかあります。
Doxygen は、\see
(と同義\sa
) および\link
コマンドを受け入れます。これらが期待どおりに機能しない場合は、OP にいくつかのサンプル ドキュメントを含める必要があります。
andで囲まれたという表記{\command description}
は、doxygen のドキュメントでは一般的ではありません。プログラムがこれらをどのように扱うかはわかりません。そのため、このスタイルを使用しないことをお勧めします。{
}
私はあなたがコメントしていると思う//
Doxygen は次の方法でタグをキャッチします。
/**
* @KEYWORD DESCRIPTION
*/
doxygen がこれもキャッチするので、3 分の 1 を追加/
して各コメント行を開始させることもできます。///
javadocとdoxygenを比較し、同等のコードの例(@linkなど)を示す素晴らしい記事に出くわしました。ここで見ることができます。お役に立てば幸いです。