javadocsに画像を含める

Question

私は、視覚的なサンプルテストケースをたくさん使用しています。私のJavaソースにそれらを組み込み、Javadocでそれらをリンクする便利な方法はありますか？私のIDEは、（IDEでjavadocレンダラー機能を呼び出すことによって）コーディング中に自動的に表示できます。 Javaソースと<img>を使用しているが、それは取っていない（私はpngを使用した）。ある任意のファイルについては

Answer 1

あなたはどんな情報源を示さなかったので、私は唯一のガラス玉の推測を行うことができます...

-

（それはこのケースでは私のテストソースにあります注意してください）ドキュメントの目的に必要な場合は、パッケージディレクトリのサブディレクトリdoc-filesにそれらを置く必要があります。これらは、Javadocによって出力ディレクトリに単純にコピーされます。次に、<img>要素の相対パスを使用します。

あなたのIDEのJavadocレンダラが同じことをするのかどうか分かりませんが、試してみる価値はあります。

Answer 2

ビットは遠くにフェッチされましたが、ドキュメント内のイメージをBase64に変換してインライン化することができます。それは次のようになります。

<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADIA..." /> 

変換を行うことが可能なオンラインツールがあります：Eclipseのルナと

• http://www.base64-image.de
• http://daturi.me
• http://www.freeformatter.com/base64-encoder.html

Answer 3

には、次の作品私のために。

• コム
  • 会社
    • somepackage
      • のdoc-ファイル
        • image.png
      • Test.java
      Test.javaさんのjavadocで今

：

/** 
* <img src="./doc-files/image.png" /> 
*/ 

そして、あなたは、マウスを置くとEclipseは、両方のポップアップヘルプの画像を示しており、 Javadocビューで

imgタグにstyle="width: 100%;"を追加することもできるので、画像は表示/ポップアップサイズに調整されます。

Answer 4

ここではmavenビルドを前提として少し拡張していますが、JDK-8（厳密なHTML検証）ではjavadocツールを実行するという規定があります。

残念ながら、Netbeansでは、IDEのjavadocポップアップで画像が表示されません。this netbeans bugを開いたばかりです。あなたがよMavenのディレクトリ構造で

<img src="doc-files/foo.png" alt="Foo"> 

：

が、これはcom.foo.File.javaのjavadocの一部であると仮定（W3Schoolsのあたりの正しい方法である何のimg終了タグを、気づきません）

<build> 
    <plugins> 
     <plugin> 
      <groupId>org.apache.maven.plugins</groupId> 
      <artifactId>maven-javadoc-plugin</artifactId> 
      <version>2.10.3</version> 
      <configuration> 
       <docfilessubdirs>true</docfilessubdirs> 
      </configuration> 
     </plugin> 
     ... 

Answer 5

私はこの質問につまずいた：のpom.xml（予告docfilessubdirsがtrueに設定されている）で、src/main/javadoc/com/foo/doc-files/foo.png

そして最後に：ここに画像を見つけます私も同様に私のアイコンのプレビューを見せたいと思っていました。答えを読んだ後、私はまだ満足していなかったし、自分でそれを試しました。それは私が今得たものです：私は単に実際の画像がにあるフォルダに移動して、以前より多くの画像を管理する必要はありません。このような

 /** 
    * <img src="../../../../../../resources/com/my/project/client/images/myImage.png"><br> 
    * Icon for myImage. 
    * 
    * @return the icon 
    */