javadocs español java jar javadoc

español - java 8 documentation pdf



¿Cómo creo un jar distributable para javadocs? (2)

Creé una API que lanzo como un archivo JAR. Es propietario, así que tuve que quitar los archivos fuente.

Actualmente incluyo una carpeta separada / doc que contiene el resultado del asistente de export-to-javadoc de Eclipse. No está mal, pero me gustaría dar un paso más.

Me gustaría distribuir javadocs como un archivo jar que se puede colocar fácilmente en un proyecto futuro que incluye el archivo jar para mi API. Sé que lo he visto así varias veces con otras distribuciones que he usado, pero no he tenido suerte buscando.

El objetivo final es permitir que los futuros desarrolladores tengan fácil acceso para pasar el mouse sobre los comentarios y cosas de esa naturaleza.

¡Gracias!


Parece que es suficiente empaquetar la carpeta doc que contiene la documentación generada por eclipse como un archivo jar . Luego, si desea usar ese jar como javadocs del jar real que contiene los archivos .class compilados, asigne el jar de javadoc con el "Javadoc in archive" en Eclipse y configure el Path dentro del archivo como doc . Parece que Eclipse busca las entradas index.html y package-list en la carpeta doc.



También usar maven-javadoc-plugin puede ser una manera fácil de hacerlo. Ver el siguiente enlace:

http://www.avajava.com/tutorials/lessons/how-do-i-generate-and-deploy-a-javadoc-jar-file-for-my-project.html


Si su objetivo final es solo que los futuros desarrolladores puedan ver sus instrucciones javadoc cuando utilizan sus clases o métodos, en Eclipse puede tener la opción de exportar archivos fuente java cuando exporta su biblioteca jar como se muestra en la imagen siguiente :

Esto también permite a los desarrolladores intervenir y ver sus códigos durante la depuración.