3

私はJavadocで文書化し、Eclipseとの統合を高く評価しましたが、ダイアグラムを追加するためにDoxygenを使用したかったのです。

いくつかの簡単な説明でタグ {link foo} を使用して、標準 Java クラスおよび独自のクラスにリンクしています。

SSCCE は次のとおりです。

package org.foo.myproject;

import javax.swing.JList;

/**
 * This is a Javadoc line {@link JList}
 * 
 * @author theauthor
 * @version 1.0.0
 */
public class JavadocLinkFailedDemo {
}

Doxygen (1.8.4) で次のエラーが発生します: Warning: unable to resolve link to JList for \link command(doxygen.exe で生成された doxyfile テンプレートを使用し、.java ソースと特定の入力/出力ディレクトリ用に編集します)

これはこの質問と同様の問題ですが、トピックの作成者の解決策はうまくいきませんでした。

事前にご協力いただきありがとうございます。

EDIT1:対応するタグファイルを取得するために、doxygen を使用して Java API を生成しようとしました。次に、このファイルをこのデモ プロジェクトで使用し、1 つのパラメーターを JList として使用してコンストラクターを追加しました => リンクはこのパラメーターに対してのみ解決され、リンク コマンドでは決して解決されません。

EDIT2: 私は最終的にこの種の署名を保持することに成功しました: {@link ...}. 私の例では、次の条件を満たす場合に JList が解決されます。
- クラス ファイルの完全修飾名を記述する
- doxygen で jdk のドキュメントを生成してタグ ファイルを生成し、このタグをプロジェクトで使用する

最後のコード例は次のとおりです。

package org.foo.myproject;

import javax.swing.JList;

/**
 * This is a Javadoc line with {@link javax.swing.JList}
 * 
 * @author theauthor
 * @version 1.0.0
 */
public class JavadocLinkFailedDemo {
    /**
     * This is a Javadoc line of the constructor with {@link javax.swing.JList}
     * 
     * @param aList
     *            The list
     */
    public JavadocLinkFailedDemo(JList aList) {
    }
}

最終結果:
http://s11.postimg.org/wgndev8hv/doxy_jdk.png

ただし、.chm ヘルプ ファイルを作成するのはほとんど不可能です。これは、このタスクを実行するのに時間がかかり、ファイルが非常に大きくなるためです。しかし、それは別の問題です...

4

1 に答える 1

0

私はこれを試したことはありませんが、必要なのはあなたの前のエスケープ文字だと思います@link。これは\@linkまたは@@linkのように見えるはずですが、私は\@link.

これで、doxygen はあなたの javadoc コメントを正しく処理できるはずだと思いますが、これが JavaDoc で機能するかどうか、または JavaDoc が現在文句を言っているかどうかはわかりません。また、 , ... が表示されるはずなので、doxygen のドキュメントでは奇妙に見えるかもしれ@link JList}ません。

于 2013-08-04T08:08:05.007 に答える