2011-08-19 14 views
15

He creado una API que publico como un archivo JAR. Es propietario, así que tuve que quitar los archivos fuente.¿Cómo creo un jar distributable para javadocs?

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 soltar 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 a los futuros desarrolladores tener un fácil acceso para pasar el mouse sobre los comentarios y cosas de esa naturaleza.

Gracias!

+0

Al menos para la segunda parte de su pregunta ... Aquí encontrará instrucciones detalladas sobre cómo colocar JavaDocs en Eclipse http://stackoverflow.com/a/11579339/356895 – JJD

Respuesta

11

Parece que es suficiente para empaquetar el carpeta documento que contiene el eclipse documentación generada como un archivo jar . Entonces, si usted desea utilizar el frasco como javadocs de la jarra real que contiene los archivos .class compilados, se asigna el tarro de javadoc con el "Javadoc en el archivo" en Eclipse y establecer la ruta de dentro del mismo archivo como doc. Parece que Eclipse busca index.html y lista de paquetes entradas en la carpeta doc.

Setting Javadoc location in Eclipse

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

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

+0

Gracias por la recomendación. De hecho, me encontré con el complemento javadoc maven, aunque no quería presentar maven en un proyecto no maven. Voy a buscar más información sobre lo que realmente hace el complemento, y eso puede ayudarme a entender cómo generar un jar de javadoc sin maven. Apreciar la ayuda, haré un seguimiento con cualquier otro hallazgo. – Batman0730

+0

@ Batman0730 He editado la respuesta. ¿Podrías probar el modo en que te describí? – suat

+1

Creo que esto borra un malentendido que he tenido todo el tiempo. No puede simplemente dejar caer estos archivos javadoc.jar en un proyecto y mágicamente recibir comentarios adjuntos al código. Debe conectar javadocs manualmente a sus bibliotecas, incluso cuando estén en formato .jar. Nunca lo había probado antes, así que mi suposición estuvo equivocada todo el tiempo. Gracias por su ayuda. – Batman0730

0

Si su objetivo final es sólo para los futuros desarrolladores puedan ver sus instrucciones javadoc cuando están utilizando sus clases o métodos, en Eclipse que puede tener la opción de exportar java archivos de origen al exportar su biblioteca frasco como se muestra en la siguiente imagen:

enter image description here

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

Cuestiones relacionadas