Incluyendo imágenes en javadocs

Question

Trabajo con una gran cantidad de casos de prueba de muestra que son visuales. ¿Hay alguna forma conveniente de incluirlos en mi fuente Java y vincularlos en Javadocs, para que mi IDE pueda mostrarlos automáticamente mientras se codifica (invocando una función de renderizado javadoc en mi IDE?)

Intenté poner una imagen junto a la fuente Java y usando <img>, pero no está tomando (utilicé un png).

(nota - está en mis fuentes de prueba en este caso)

Answer 1

medida que no se presentó ninguna fuente, sólo puedo hacer una suposición de vidrio-ball ...

Para aquellos archivos que tengan necesario para fines de documentación, uno debe ponerlos en un subdirectorio llamado doc-files de sus directorios de paquetes. Estos serán simplemente copiados por Javadoc en el directorio de salida. Luego use una ruta relativa en el elemento <img>.

No estoy seguro de si el renderizador de Javadoc de IDE hará lo mismo, pero vale la pena intentarlo.

Answer 2

Un poco exagerado, pero puede alinear las imágenes en la documentación convirtiéndolas en Base64. Se vería así:

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

Existen herramientas en línea disponibles para hacer la conversión:

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

Answer 3

Con Eclipse de Luna las siguientes obras para mi.

• com
  • empresa
    • algunpaquete
      • doc-archivos
        • image.png
      • Test.java

Ahora en javadoc de Test.java:

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

y Eclipse muestra la imagen tanto en la ayuda emergente, cuando se pasa el ratón, y en la vista de Javadoc.

Incluso puede agregar style="width: 100%;" a la etiqueta img, por lo que la imagen se ajusta al tamaño de vista/ventana emergente.

Answer 4

Expandir un poco la respuesta de Paŭlo suponiendo que una compilación maven aquí es lo que funcionó para mí con JDK-8 (validación de HTML más estricta), con la condición de que está dispuesto a ejecutar la herramienta javadoc.

Desafortunadamente con Netbeans no puedo ver la imagen en la ventana emergente javadoc del IDE, acabo de abrir this netbeans bug.

Supongamos que esto es parte del Javadoc para com.foo.File.java (notará ninguna etiqueta final IMG, que es la manera correcta por w3schools):

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

En la estructura de directorios experto podrás encontrar la imagen aquí: src/main/javadoc/com/foo/doc-files/foo.png

Y por último, en el pom.xml (aviso docfilessubdirs se establece en true):

<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

me encontré con este pregunta También quería mostrar una vista previa de mis íconos. Después de leer las respuestas, aún no estaba satisfecho y lo intenté por mí mismo. Eso es lo que tengo ahora:.

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

como esto no necesito para gestionar más imágenes que antes simplemente yendo a la carpeta de las imágenes reales se encuentran en