くの、めんどくさいんだよなjavadocの継承作業のための外部Api?（Maven2)

StackOverflow https://stackoverflow.com/questions/3401642

質問

クラスオーバーライドは、コンクリートの方法を実装し、抽象メソッドのJavadocを自動的に継承されない限り明示的に上書きされます。

または、少なくとも、ツールともよろしくお願いします。そうでない作業のためのリンクが外部のApiを用意しています。例えば、私が私のコード実行 java.util.Map, 違いによるものなのか、それとも他のJREのjavadocsは引き継がれません/からコピーされJRE javadocs/apidocs.

私の特定の場合に行うことにより設定のMaven2のJavadocプラグインですが、同時にjavadoc CLIを起動ツールです。

私Maven2のJavadocプラグインの設定現在のようになります。

<reporting>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-javadoc-plugin</artifactId>
      <version>2.7</version>
      <configuration>
        <stylesheet>maven</stylesheet>
        <links>
          <link>http://download.oracle.com/javase/6/docs/api</link>
        </links>
      </configuration>
    </plugin>
  </plugins>
</reporting>

任意のポう。

役に立ちましたか？

解決

として@スティーブン上のソースファイルを継承したメソッドのご用意となのパスを指定 -sourcepath.このJavadocツールのドキュメンテーション

自動コピーの方のコメント

のJavadocツールする機能を コピーは"継承方法"にコメント クラスおよびインタフェースの 以下の二つの状況です。コンストラクタ、および入れ子 授業は継承しませんdoc。

  • 自動的に継承へのコメントを埋めテキスト -が 主 説明, や @return, @param または @throws タグが欠けてい からのコメント方法のJavadoc ツールのコピーに対応する主な 載又はタグからのコメント 方法でオーバーライドを実装した場合 任意のアルゴリズム ます。

    具体的には、 @param タグは、特定の パラメータ、足りないものがありましたら、そのコメント このパラメータからコピーされ 法の継承 上位の階層となります。の場合 @throws タグ 特定の例外を @throws タグはコピーされた場合に限る 例外を宣言しています。

    この動作に対しバージョン1.3以前は、 存在の主な記載又は タグによって予防すべてのコメント て引き継がれます。

  • 明示的に受け継ぐコメント {@inheritDoc} タグ インフォメーションの インラインでタグ {@inheritDoc} a 法主記載又は @return, @param または @throws タグのコメント-- に対応する主を継承 載又はタグのコメントをコピー るものにスポットです。

のソースファイルを継承 方法だけのパス 指定した -sourcepath のための ドキュメントへのコメントすること ご利用にコピーします。もしクラス でも、そのパッケージが必要で渡され にョンをインストールして下さい。これに対 と1.3倍となっております。xおよびそれ以前リリースの場 のクラスでなければなり 文書化され クラス

まだの <sourcepath> オプションの設定パラメータのjavadocプラグインといわれているデフォルトの発生源のプロジェクト）。

ちなみに、 <links/> ではできないか他の、あなたの <links/> はを付加するために使われるデジタルカメラは外部へのリンク。実際に、使用しないように推奨します。から リンクの設定:

以来、2.6、Javadoc APIのリンクによっては、JDKバージョンの使用により、プロジェクトが追加されます。のインタプリタのバージョンをJavadoc APIが検出されたの値から <source/> パラメータの org.apache.maven.plugins:maven-compiler-plugin (定義される ${project.build.plugins} または ${project.build.pluginManagement}や計算のJavadocツールの実行形式にまとめたものです。スキップしたい場合はこのリンクをクリックを設定する必要があり <detectJavaApiLink/> へ false.

注意： を使用している場合には、これは未サポートJDKのように7.0、追加、Javadoc APIのurlを使用 <javaApiLinks/> パラメータ、すなわち:

<configuration>
  <javaApiLinks>
    <property>
      <name>api_1.7</name>
      <value>http://download.java.net/jdk7/docs/api/</value>
    </property>
  </javaApiLinks>
  ...
</configuration>

参照 <links/> パラメータです。

ときは、事前に設定され1.6 source レベルのコンパイラのプラグイン、クロス文献へのリンクは、Java APIで作品（リンクポイント http://download.oracle.com/javase/6/docs/api/あの追加のためのJava APIです。

もの作品を箱から出してます。あったかを追加するリンク部のクロスを参照す。

変わっている。ただ実際に指定しcomplier source レベルとして記録され?だが、ここで何を作ろ

  <plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-compiler-plugin</artifactId>
    <configuration>
      <source>1.6</source>
      <target>1.6</target>
    </configuration>
  </plugin>
  <plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>2.7</version>
    <configuration>
      <!-- No need for this -->
      <!--
      <javaApiLinks>
        <property>
          <name>api_1.6</name>
          <value>http://download.oracle.com/javase/6/docs/api/</value>
        </property>
      </javaApiLinks>
      -->
      <links>
        <link>http://commons.apache.org/dbcp/apidocs/</link>
        <link>http://commons.apache.org/fileupload/apidocs/</link>
      </links>
    </configuration>
  </plugin>

他のヒント

まだ明確な答えをいていますが、私の作品をパズルの javadoc ユニーズをできる のソースコード 該当する外部Apiをjavadoc産を残すつもりはない遺産を残す。

また同様の質問にStackOverflow方々がこの問題の受け答えのこquestsion: maven-javadoc-プラグインとinheritDocのためのJava APIのコアクラス

概要： 継承していくためにはJavadocからJavaコアクラスが必要で解凍源としてのJavadocます。源のJavaコアクラスは提供している src.zip ファイルのJDK distro.

ライセンス： CC-BY-SA と 帰属
所属していません StackOverflow
scroll top