llama - ¿Cómo se debe distribuir el Javadoc para una biblioteca?

generar javadoc eclipse

Question

Estoy escribiendo una biblioteca personalizada. Es construir en un archivo .jar. ¿Soy capaz de generar el javadoc, pero no sé cómo debería distribuirlo?

1. Ponlo en el mismo .jar con la biblioteca.
2. Ponlo en un .jar diferente.
3. De alguna otra manera?

¿Y cómo incluir el javadoc en otro proyecto que usa mi lib?

1. Si lo hubiera puesto en el mismo .jar, ¿debería haber escrito algo en el manifiesto?
2. Si está en un .jar separado, ¿es suficiente incluirlo en el proyecto?

Estoy usando NetBeans 9.1.

Answer 1

Es una práctica general mantener los JavaDocs en un archivo separado. o incluso más comúnmente, en un directorio llamado ''docs''. no es necesario inflar innecesariamente el archivo de su biblioteca con los archivos html y js.

¿Y por qué querría incluir los JavaDocs [html + js] generados en su proyecto? Mientras los comentarios del código fuente de JavaDoc estén en su lugar, alguien que use su biblioteca podrá verlos simplemente al pasar el mouse sobre el mouse en cualquiera de los IDE modernos.

Actualizar
Según el comentario de nanda a continuación, verifiqué lo mismo y él ES correcto. En mi proyecto, en realidad he adjuntado Javadocs de la carpeta ''doc'' al archivo para poder verlos con el mouseover.

Answer 2

Incluiría la biblioteca .jar y la documentación y otras cosas, como un archivo README, Licencia, etc. en un solo archivo (zip o tar.gz)

mylib-1.0.1.tar.gz, que contiene:

mylib-1.0.1/
├── javadoc
│   └── index.html (and all other javadoc files under here)
├── mylib-1.0.1.jar
└── README

En lugar del directorio javadoc / sub expandido dentro del archivo, puede agregar el javadoc comprimido en un mylib-1.0.1-javadoc.jar (o zip), ambas opciones son comunes.

mylib-1.0.1/
├── mylib-1.0.1-javadoc.jar
├── mylib-1.0.1.jar
└── README

Answer 3

Otra forma: para mí, esta fue la mejor opción: (agregar a build.xml. Lo probé en NetBeans IDE 7.0 y 7.2.1) (lo encontré en la generación automática y los archivos de documentos en Netbeans )

<target name="-post-jar" description="bundle sources and javadoc in a jar" depends="javadoc">
<jar compress="${jar.compress}" basedir="${src.dir}" jarfile="${dist.dir}/${application.title}-sources.jar"/>
<jar compress="${jar.compress}" basedir="${test.src.dir}" jarfile="${dist.dir}/${application.title}-test.jar"/>
<jar compress="${jar.compress}" basedir="${dist.javadoc.dir}" jarfile="${dist.dir}/${application.title}-javadoc.jar"/>

Esto creará cuatro frascos, uno para el programa de aplicación, uno para fuentes, uno para pruebas y otro para javadoc.