問題タブ [maven-javadoc-plugin]

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があります (コメントがロシア語で申し訳ありません)。

リンクされたクラス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出力に表示されます。

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

私はこのpom.xmlような宣言をしています

コマンドラインからそれをオフにする方法はありますか？

それをプロファイルに抽出できることは知っていますが、それは私が望んでいることではありません。

私はこのようなマルチモジュールmavenプロジェクトを持っています

すべての Java ファイルの apidoc を作成したいと考えています。プロジェクト ルートで mvn javadoc:aggregate を実行すると、プロジェクト ルートのターゲット ディレクトリ (target/sites/apidocs) に apidcos が作成されます。しかし、私が望むのは、第 2 レベルのモジュールごとにこの apidoc を作成することです。たとえば、framework1 のすべての Java ファイルの apidoc を、framework1/target/sites/apidocs に作成する必要があります。同じことがframework2にも当てはまります。最終結果はこのようになります

Maven javadoc プラグインを使用してそれを行う方法を教えてください。

編集：framework1のpom.xmlには含まれています

私はmaven3を使用しており、新しいmaven 3 siteplugin+javadoc構成に従ってjavadocを構成しています。ただし、私のjavadoc構成パラメーターはすべて無視されているようです。したがって、パッケージのグループ化やソースのリンクなどはありません。

私のプロジェクトはマルチモジュールプロジェクトです。使用するコマンドは次のとおりです。mvn3cleanpackagejavadoc：aggregate

これが私のルートpomの関連部分です。

Javadoc サイトから一連のパッケージを除外しようとしています。

残念ながら、このプラグインは独自の機能を持っているようで、レポート プラグインとして構成すると、access deniedファイルの移動時に失敗したため、通常のプラグインに変更し、サイトの目標 (集計) で実行するように構成しました。これにより、javadoc が生成され、本来あるべきサイトで公開されます。

しかし、プラグインの構成パラメーターがまったく有効にならないようです。要素を移動しようとしました<excludePackageNames>-一般的な構成と集約目標の特定の構成の両方です-コードベース全体の除外を追加しましたが、すべてのファイルがまだ生成されていました.

私がやろうとしているのは、javadoc にあってはならないいくつかのパッケージを単純に削除することです。パッケージを除外するために、このプラグインと構成をうまくプレイできるようになった人はいますか?

これは私が現在使用している構成です。javadoc は作成されますが、除外されたものを含むすべてのパッケージが生成されます。

何かアイデアはありますか？

Right now I am using the maven-javadoc-plugin to attach the Javadoc to .jar artifacts when I am doing a release.

However, how can I generate the Javadoc in an html format so we can scp it to a remote server for reference?

Thanks!

カスタム ドックレットを使用してカスタム javadoc タグからレポートを生成し、Maven サイト プラグインと javadoc プラグインを使用して、このレポートと通常の Java API ドキュメントの両方を生成します。

POM のセクションは次のようになります。

Maven 2 ではこれで問題なく動作しますが、Maven 3 では 1 つのレポートのみが生成され、POM で指定された最後のレポートになります (reportSet要素を交換することによって確認されます)。

いくつかの実験の後、通常のレポートの目標を「javadoc」から「test-javadoc」に変更すると、両方のレポート セットから出力が得られることがわかりました。したがって、Maven 3 では、同じ javadoc-plugin ゴールを使用する 2 つのレポートを生成できないことが問題のようです。

これはバグですか、それとも私が見逃した設定がありますか? http://maven.apache.org/plugins/maven-site-plugin-3.0-beta-3/maven-3.htmlで説明されているように、maven-javadoc-plugin セットアップをサイト プラグインの から に移動しreportingましconfigurationた。役立たず。Maven 3.0.4、maven-site-plugin 3.0-beta-3、maven-javadoc-plugin 2.8.1 を使用しています。

ありがとう！