問題タブ [maven-javadoc-plugin]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票する
1 に答える
737 参照

java - NetBeans: JavaDoc が表示されない

私は大きな問題を抱えています。つまり、私は NetBeans 7.1.2 を使用していますが、JavaDoc がすぐに表示されることはありません。メソッドを入力すると、インターネットで「JavaDoc をダウンロードしています」と言って JavaDoc が検索されます。次に、メソッドの JavaDoc のみが表示されます。JavaDoc を手動でダウンロードしてネットビーンズに設定しようとしましたが、それでもうまくいきません。次の画像で問題を明確に説明します。

JavaDoc はインスタントではありません。 ダウンロード中です

JavaDoc は手動で追加されます

ここでは、JavaDoc をダウンロードしています ここでは、JavaDoc を手動で追加します

0 投票する
1 に答える
563 参照

maven - Mavenでjavadocを生成してから、scp経由でアップロードしますか?

現在、Maven javadocプラグインは正常に機能していますが、scpを介してリモートディレクトリに追加する方法がわかりません。

scpを介してjavadocファイルを転送するにはどうすればよいですか?ただし、生成された後はどうすればよいですか?これは、site:siteを呼び出すときに自動的に発生しますか?

ありがとう!

0 投票する
4 に答える
13693 参照

maven - Maven を使用して機能ブランチを継続的に構築およびデプロイする方法は?

私のチームは機能ブランチを使用して新しい機能を実装し、ユーザーが使用できるようにスナップショット ビルドをリモート リポジトリに継続的にデプロイしています。したがって、「デプロイ」は実際には「リモート Maven リポジトリへの配布」を意味するだけです。現在、次の理由により、マスター ブランチの継続的インテグレーション ビルドのみを実行しており、フィーチャー ブランチでは実行していません。Maven を使用してプロジェクトをビルドし、JavaDoc とソースを JAR と共に配布しています。

私の計画は、各機能ブランチのビルドに分類子を追加することであり、次のような成果物を作成およびデプロイするときに使用されることを期待していました。

  • ブランチ: マスター
  • 分類子: なし
  • アーティファクト: foo-${version}.jar、foo-${version}-sources.jar、foo-${version}-javadoc.jar

  • ブランチ: 機能-X

  • 分類子: myfeature
  • アーティファクト: foo-${version}-feature.jarfoo-${version}-sources-feature.jarfoo-${version}-javadoc-feature.jar

アーティファクトの正確な名前はあまり気にしません。機能ブランチ用にメイン、ソース、および JavaDoc アーティファクトを個別に必要とするだけです。JavaDoc プラグインもソース プラグインも分類子が構成されているとは見なさないため、マスター ビルド用に作成されたアーティファクトを効果的に上書きします。

おそらく問題は解決しますが、artifactId を変更したくはありません。機能ブランチと Maven との継続的統合にどのようにアプローチしますか?

0 投票する
1 に答える
57 参照

maven - 継承に基づくクラスを含む Java ドキュメント

私が「Java docs」を書いたことに注意してください.javadocユーティリティが私が求めているものを達成するとは必ずしも期待していないためです(私が使用しているmaven-javadoc-pluginは言うまでもありません)。

特定のインターフェイスを拡張/実装するクラスのみを含むドキュメント サイトを作成する必要がありますが、残念ながら、そのようなクラスは、パッケージ パスでフィルタリングすることによってこれを実行できる論理パッケージ構造に配置されていないようです。

助言がありますか?

0 投票する
1 に答える
2513 参照

maven - Maven JavaDocプラグイン:依存関係の集約

次のコマンドでJavaDocsをコンパイルしようとしています。

次のようなエラーが発生し続けます。

明らかに、マルチモジュール/アグリゲーションプロジェクトの依存関係が認識されていません。これらは両方とも、私のモジュールのpom.xmlファイルの1つで依存関係としてマークされています。maven-javadoc-plugin親pom.xmlに追加の引数を指定する必要がありますか?

編集:

私は走りましたmvn install、そしてそれはうまくいったようでした。私の親pom.xmlは:

バージョンは古くなっていますが、それは問題ではなかったようです。

0 投票する
1 に答える
1947 参照

java - 完全修飾クラス名を与えるJavaDoc...どのように省略しますか?

問題

私はmvn javadoc:javadocJavaDocを生成するために実行していますが、結果に満足しています。ただし、サードパーティのライブラリまたは独自のコードベースに由来するクラスの完全修飾クラス名が提供されます。例えば、

これらのクラスの1つを返すメソッドに対して、 com.project.beans.BeanAcom.project.beans.BeanBの戻りタイプを提供します。

これは、JSONオブジェクトを受け取るメソッドのパラメータータイプorg.codehaus.jettison.json.JSONObjectを提供します。(これに対して、java.lang.Integerを受け取るメソッドのパラメーター型はIntegerになります。)

質問

読みやすくするために、これらのクラスの省略名を生成する方法はありますか?つまり、BeanA、BeanB、JSONObjectです。

そして、XML構成なしでこれを行う方法はありますか?

前もって感謝します :-)

0 投票する
0 に答える
70 参照

java - 複数のコード リポジトリにまたがるリンクされた javadoc

さまざまなコンポーネントが約 100 の git リポジトリに分散しているアプリケーションがあります。それらはすべてスタンドアロンの Maven プロジェクトであり (もちろん、それらの間には依存関係があります)、アプリケーション用にそれらすべてをバンドルして .war を作成します。

可能な限り完全に相互リンクされた javadoc を作成したいと考えています (別の Maven プロジェクトからの型に関する言及は、その javadoc ページにハイパーリンクされています)。Maven javadoc プラグインはそれを許可していないようです。これを行うことができるmaven構成/他の方法はありますか?

ありがとう、アマン

0 投票する
2 に答える
5192 参照

java - JavaDocの代替出力ディレクトリ

マルチモジュールMavenプロジェクトでJavaDocsの代替出力場所を構成しようとしています。親POMのmaven-javadocを次のように構成しました。

そして、ここでproject.reporting.outputDirectoryを設定します。

ただし、Mavenは上記の構成を考慮していないようであり、それにもかかわらず、デフォルトのディレクトリにJavaDocを出力しています。どうしてこれなの?

また、project.reporting.outputDirectory変数に相対パスを使用しました。mvn javadoc:javadocこの相対パスは、サブモジュールで実行した場合と親モジュールで実行した場合と同じ意味になりますか?

よろしくお願いします...大歓迎です!

0 投票する
2 に答える
506 参照

java - すべてのモジュールに代替JavaDocの場所を設定する最良の方法は?

マルチモジュールMavenプロジェクトのすべてのモジュールに代替JavaDocの場所を設定したいと思います。残念ながら、これはSubversionのチームプロジェクトであり、絶対パスが私たち全員にとって同じになることはないため、相対パスに依存するか、${basedir}などのMavenプロパティを使用する必要があります。

これを行うための最良の方法は何ですか?プロジェクト構造がある場合

そして、APIをsub3 / docsに配置したいのですが、親モジュールがサブモジュールとは異なるパスを認識するときに、すべてのモジュールがsub3 / docsにHTMLファイルを出力するように指示するにはどうすればよいですか?

前もって感謝します。

0 投票する
2 に答える
3241 参照

maven - プロジェクトでカスタムドックレットクラスをコンパイルして実行するにはどうすればよいですか?

コンパイル時にすべてのクラス javadoc コメント (できればライブラリ WebPage クラスのサブクラス) を .properties ファイルにダンプしようとしていますclassname=comment

これまでのところ、私は持っています:

  • 作成されたドックレット クラスSiteMapDoclet
    • このクラスは、プロジェクト内のすべての javadoc をスキャンし、それらを .properties ファイルにダンプするように定義されています
  • それが機能するために必要な構成を私の pom.xml に追加しました。

バージョン: Java 1.6.0.21、Maven 2.2.1

問題:
mvn site返品:

AdditionalDependenciesプロジェクトの通常の依存関係であっても、jarを設定しようとしました。また、クラスが bootclasspath の一部として必要とする jar へのパスを追加しようとしました。

私の pom.xml のレポート セクションは次のようになります。

注:
${m2Repository}はファイルの上位にあるプロパティとして定義され、 はファイルの
上位${env.USERPROFILE}/.m2/repository
${bootClassPath}にあるプロパティとして定義され、次のように
定義されます。${env.JRE_6_HOME}\lib\rt.jar;${env.JAVA_HOME}\lib\tools.jar;

どうすれば修正できますNoClassDefFoundErrorか?

さらに、SiteMap ファイルを通常のビルド プロセスの一部として実行したいと考えていcompileますpackage

でこれを定義しようとしましbuildたが、javadoc が作成されず、ドックレットからのログ出力が表示されません。

更新:
@ ben75 の提案に感謝します。pom.xml<reporting>のセクションを削除したところ、ビルド中にプロセスが失敗しました。からセクションを追加してコピーしました。<goals><configuration><reporting>

それはまだスローされてNoClassDefFoundErrorいますが、私が望むビルドで起こっています。追加してみました:

構成セクションに移動しましたが、うまくいきませんでした。