2011-05-05 19 views
6

¿Hay alguna manera de incrustar javadoc (/ carpeta doc producida por JavaDoc Ant Task) en mi jar biblioteca que contiene mis archivos .class?Cualquier forma de incrustar javadoc en un jar

Preferiría no enviar la fuente y me gustaría que los usuarios puedan ver los comentarios de javadoc en eclipse sin tener que pasar por la pestaña Bibliotecas referenciadas y agregar el código JavaDoc a mi lib de terceros.

Respuesta

1

Claro que puedes update un archivo jar de esta manera.

jar uf <your_jar> doc/<your doc file>

3

Claro que se puede poner Javadoc en su archivo JAR binario ... pero ¿realmente tiene sentido?

Para leer los javadocs, un usuario tendrá que descomprimir los archivos HTML del archivo JAR en el sistema de archivos de Android, y luego señalar el navegador Android en el archivo index.html (o lo que sea). Pero el mejor modelo para usar el archivo JAR para ejecutar su código NO es descomprimirlo. Y si no espera que sus usuarios intenten ver el javadoc en sus teléfonos (!?!) ... entonces poner los javadocs en el archivo JAR es "peso muerto".

Tiene mucho más sentido distribuir el árbol de javadoc en un archivo zip o tar separado.

Finalmente, si espera que los usuarios desarrollen código contra las API en su producto, será mucho más fácil para ellos si les proporciona el código fuente. Obtendrá una mejor satisfacción del cliente, menos solicitudes de asistencia para ayudarlo a depurar su código y menos quejas injustificadas sobre el hecho de que su código no funcione.

+0

No quiero que vean el javadoc desde el teléfono, es el último donde quiero que lo utilicen como API. Desearía poder distribuir la fuente, pero no puedo por razones de licencia. Me gustaría que mi biblioteca sea como Google envía Android. Puedo ver los documentos de la API de Android, pero el android.jar solo contiene clases. – AndroidPlaya

+0

* "Puedo ver los documentos de la API de Android, pero el android.jar solo contiene clases." * ¡Precisamente! Google no coloque los javadocs en el JAR binario ... y tampoco debería. –

Cuestiones relacionadas