4

maven-site-plugin と maven-javadoc-plugin ( doclava docletを使用) を構成したので、 によって生成されたサイトで適切な JavaDoc を取得しようとしていますmvn site。私のコードには、いくつかの JUnit テスト クラス ( src/test/java/my/package/*.javaにあります) があり、これらの JavaDoc コメントはソース クラス ( src/main/java/my/package/*.javaにあります)にリンクしています。 . 問題は、Test JavaDoc を生成するときに、javadoc がソース クラスのドキュメントがどこにあるかを見つけられないことです。maven-javadoc-plugin の構成オプションを使用して、javadoc にそれを見つける場所を伝えようとしました (linksここに文書化されています)。offlineLinks）、しかし運が悪い。生成されたドキュメントをオフラインで表示するときに (ブラウザで/path/to/project/target/site/index.htmlを参照して)実行できるように、javadoc に相対リンクを生成してもらいたいと考えています。Test JavaDocs 生成を無効にしたくありません

私の pom.xml | mvn サイトの出力からの抜粋

また、私はJavaとMav​​enの初心者です

質問を明確にするために、ここに例を示します。src/test/java/name/earshinov/PrefixCircuits/GenerateATest.javaにテスト クラスGenerateATestがあります (コメントがロシア語で申し訳ありません)。

package name.earshinov.PrefixCircuits;
// imports skipped

/**
 * Тестирование алгоритма построения вспомогательных подсетей типа A,
 * реализованного в классе {@link name.earshinov.util.PrefixCircuitGenerator},
 * по отдельным случаям, описанным в оригинальной статье
 */
public class GenerateATest {
// ...

リンクされたクラスPrefixCircuitGeneratorはsrc/main/java/name/earshinov/PrefixCircuits/PrefixCircuitGenerator.java にあります。を実行するmvn siteと、ソース クラスのJavaDocs がtarget/site/apidocs/index.htmlに、Test JavaDocs がtarget/site/testapidocs / index.html に取得されます。Test JavaDocsのドキュメントでは、ソース クラス JavaDocsGenerateATestのドキュメントへのリンクを参照したいと思います。PrefixCircuitGeneratorただし、javadoc は参照先が見つからPrefixCircuitGeneratorないため、リンクを生成せず、対応する警告がmvn site出力に表示されます。

[WARNING] /home/eugene/dev/java/PrefixCircuits-maven/src/test/java/name/earshinov/PrefixCircuits/GenerateATest.java:9: warning 101: Unresolved link/see tag "name.earshinov.util.PrefixCircuitGenerator" in name.earshinov.PrefixCircuits.GenerateATest

私の目的は、（どういうわけか）javadocにリンクの生成方法を伝えることです。に変更{@link name.earshinov.PrefixCircuits.PrefixCircuitGenerator}しても何も変わり{@link PrefixCircuitGenerator}ません。

4

1 に答える 1

0

実験のための時間がありました。doclava doclet は、外国のドキュメント リンクをサポートしていないようです (-linkコマンド ライン オプションを実装していません)。CLIからjavadocを実行して発見しました。おそらく javadoc プラグインは、-linkオプションが標準ドックレットに固有であることを認識しているため、別のドックレットが使用されている場合、pom.xml からこのオプションの値を取得し、コマンドライン引数を介して javadoc に渡す必要はありません。したがって、エラーは生成されません。

于 2011-09-05T22:00:31.893 に答える