¿Cómo adjuntar javadoc o fonts a los archivos jar en la carpeta libs?

Nueva versión del complemento ADT r17 para la característica agregada de Eclipse para configurar automáticamente las dependencias de JAR. Todos los archivos .jar en la carpeta / libs se agregan ahora a la configuración de comstackción. Lamentablemente, el contenedor classpath de Dependencias de Android no es modificable.

Ruta de clases de dependencias android no modificables

¿Cómo puedo adjuntar javadoc y fonts a la .jar (de la carpeta / libs) insertada automáticamente?

La mejor manera de responder a su pregunta es resumir las respuestas de Xavier , plastiv , VinceFR y Christopher .

Guía paso por paso

Para vincular las fonts y javadoc a una biblioteca .jar que Eclipse vincula automáticamente, debe hacer lo siguiente:

  1. Coloque el archivo .jar de la biblioteca en la carpeta libs y los archivos .jar y doc .jar de origen asociados en subcarpetas separadas, como libs / src y libs / docs . Puede usar un nombre que no sea src y docs si lo desea, pero es importante que los archivos .jar no estén directamente en la carpeta libs .
  2. Cree un archivo .properties en la carpeta libs con el nombre exacto de la biblioteca real .jar (ver ejemplo). Asegúrate de mantener la parte .jar .
  3. Especifique las rutas relativas a las fonts y javadoc .jar en el archivo .properties .
  4. ¡Cierre y vuelva a abrir el proyecto Eclipse! Opcionalmente, actualice el proyecto presionando F5 .
  5. Seleccione un objeto de la biblioteca vinculada en el código fuente.
  6. Abra la vista Javadoc en Eclipse para verificar la documentación (ver captura de pantalla).
  7. Abra la statement del código fuente (acceso directo predeterminado: F3 ) del objeto seleccionado.

Ejemplo

El ejemplo usa la biblioteca Gson .

Estructura del directorio de la carpeta libs:

 libs ├── docs │  └── gson-2.2.2-javadoc.jar ├── gson-2.2.2.jar ├── gson-2.2.2.jar.properties └── src └── gson-2.2.2-sources.jar 

Contenido de gson-2.2.2.jar.properties

 src=src/gson-2.2.2-sources.jar doc=docs/gson-2.2.2-javadoc.jar 

Información Adicional

Por supuesto, puede mover el javadoc y las fonts .jar a otras carpetas y especificar rutas relativas. Eso depende de usted. Colocar el origen y los archivos javadoc directamente en la carpeta lib es posible, pero no recomendado , ya que esto hace que la documentación y el código fuente se incluyan en su aplicación .

Captura de pantalla del panel Eclipse JavaDoc:

Vista de JavaDoc en Eclipse

Captura de pantalla de un proyecto de Eclipse usando Gson con Android 4.2.2 .:

Captura de pantalla del proyecto de prueba Eclipse


Hace referencia a javadocs desempaquetados

En caso de que quiera hacer referencia a los javadocs que no se proporcionan como un .jar empaquetado, simplemente haga lo siguiente con los archivos y las carpetas que le solicitó el desarrollador de Android :

  1. Coloque la biblioteca .jar en la carpeta libs/
  2. Cree un archivo yourlibraryname.jar.properties ( no olvide el .jar ) con el siguiente contenido:

      doc=docs 
  3. Agregue las carpetas javadocs a la carpeta libs/ .

Deberías crear la siguiente estructura de carpetas:

 ├── docs │  ├── allclasses-frame.html │  ├── allclasses-noframe.html │  ├── com │  │  └── google │  │  └── ads │  │  ├── Ad.html │  │  │ .... │  │  └── package-tree.html │  │  ... │  └── stylesheet.css ├── GoogleAdMobAdsSdk-6.4.1.jar └── GoogleAdMobAdsSdk-6.4.1.jar.properties 

¡No olvide cerrar y volver a abrir el proyecto Eclipse como se menciona arriba! Aquí hay una captura de pantalla de un proyecto de ejemplo que hace referencia a la biblioteca de Android de GoogleAdMobAds .

GoogleAdMobAds biblioteca Android proyecto Eclipse

En Windows, debe escapar de la barra inclinada invertida para obtener referencias de las rutas doc y src en el archivo de propiedades. Ejemplo, para android-support-v4.jar el contenido del archivo de propiedades es algo así como:

 doc=C:\\Program Files (x86)\\Android\\android-sdk\\extras\\android\\support\\v4\\docs src=C:\\Program Files (x86)\\Android\\android-sdk\\extras\\android\\support\\v4\\src 

Una respuesta proviene de http://code.google.com/p/android/issues/detail?id=27490#c21

En su carpeta libs, debe tener:

 doc(folder) foo_doc(folder) index.html ... ... foo.jar foo.jar.properties 

Y en tus foo.jar.properties , simplemente pon doc=./doc/foo_doc

Quizás deba actualizar su proyecto, limpiarlo, cerrarlo y volver a abrirlo.

¡Esto funciona para mi!

Intenté todo lo anterior y ninguno de ellos funcionó para mí. Descubrí un método que siempre funcionará. Básicamente, el culpable es la forma en que el ADT trata la carpeta “libs”, así que dejé de usar la carpeta “libs”. En su lugar, creé una carpeta de “bibliotecas” y la usé.

Puede hacer lo siguiente y siempre funcionará, incluso si el ADT debe cambiar la forma en que cambia la forma en que trata la carpeta “libs” en el futuro:

  1. Crea una carpeta de “bibliotecas”.
  2. Cree una subcarpeta debajo para cada biblioteca.
  3. Coloque todos los archivos para cada biblioteca en la carpeta apropiada (archivo java jar, archivo jar de origen, archivo javadoc jar, etc.).
  4. Agregue el archivo java jar para cada proyecto en la pestaña “Bibliotecas” para la ruta de comstackción de Java haciendo clic en el botón Agregar tarros ... para agregar el jar de la subcarpeta de la biblioteca en la carpeta “bibliotecas”.
  5. Adjunte la fuente / javadocs a cada proyecto abriendo el proyecto en la pestaña “Bibliotecas”, seleccionando el elemento deseado y haciendo clic en el botón Editar ... para agregar la fuente / javadocs de la subcarpeta de la biblioteca en las “bibliotecas” carpeta.
  6. Marque la checkbox de cada proyecto en la pestaña “Ordenar y exportar” para la ruta de comstackción de Java.
  7. Después de verificar que todas las bibliotecas se han movido, elimine la carpeta “libs”.

Al seguir el procedimiento anterior, su proyecto tendrá carpetas que se verán así:

enter image description here

Su ruta de comstackción Java se verá más o menos así:

enter image description here

En Order and Export las bibliotecas están marcadas:

enter image description here

Por ahora, mueva la biblioteca a la que desea Javadoc. Ellos agregan esa biblioteca a la Build Path y agregan el Javadoc.

Mira este comentario en los problemas de Android.

En ADT 22 no pude acceder a Javadoc para ambos commons -io-2.4.jar y android-support-v4.jar

Esta es la forma en que lo arreglé:

  1. Condición previa: ambas bibliotecas se enumeran en “Bibliotecas a las que se hace referencia”.

  2. Haga clic derecho en commons-io-2.4.jar y seleccione Propiedades. Esta ventana aparece:

enter image description here

commons-io-2.4.jar se incluye con commons-io-2.4-javadoc.jar, así que especifiqué el Javadoc en el archivo Ruta de archivo externo.

Hice lo mismo para la biblioteca de soporte: haga clic derecho en android-support-v4.jar y seleccione Propiedades. Esta pantalla aparece:

enter image description here

Esta vez, especifiqué la ruta al directorio de origen.

La referencia de la biblioteca a commons-io-2.0.1.jar se rompió cuando actualicé a SDK Tools y a la revisión 17 de ADT.

Para resolver el problema, utilicé Project -> Properties -> Java Build Path y seleccioné la pestaña Libraries. Eliminé cualquier referencia a commons-io-2.0.1.jar y luego utilicé Add Jar para volver a agregar commons-io-2.0.1.jar al proyecto. Luego hago clic en la flecha ‘>’ al lado del nombre de la biblioteca para expandir la referencia de la biblioteca y utilicé los botones de edición para establecer el archivo adjunto Fuente y la ubicación Javadoc.

Lo siento, no puedo publicar una imagen ya que no tengo suficientes representantes (por favor …).

Parece ser un objective en movimiento pero, después de haber recogido partes y piezas de muchos lugares (incluidas las respuestas a esta misma pregunta que ayudó pero no describió todos los detalles necesarios, o tal vez el sistema había cambiado ligeramente mientras tanto), esto parece ser la solución, al menos a partir de ahora (28 de agosto de 2013).

  • Abre una carpeta para tus javadocs en algún lugar que no esté dentro de tu proyecto.
  • Pon tus javadocs allí descomprimidos, cada uno en su propia carpeta.
  • Dentro de su carpeta lib , agregue un archivo xxx.jar.properties para cada xxx.jar.properties con la que desee asociar un javadoc.
  • En ese archivo de propiedades, consulte la carpeta en la que descomprimió el javadoc apropiado (en Windows, escape las barras diagonales inversas):

doc=d:\\Android\\javadoc\\libGoogleAnalyticsServices

  • Cierre y vuelva a abrir su proyecto en Eclipse (refrescar no es suficiente). Ahora debería ver la información sobre herramientas cuando pase el mouse sobre las clases apropiadas.

No observar ninguno de estos pasos (no descomprimir el javadoc, hacer referencia a un archivo en lugar de una carpeta, etc.) parece romperlo.

Sé que esta pregunta es bastante antigua, pero cuando ayer enfrentaba el mismo problema y la solución publicada anteriormente era demasiado molesta para mí, descubrí que se puede agregar fácilmente una definición de ruta fuente al archivo .classpath del proyecto. Eclipse lo adaptará y podrá navegar por la fuente.

entrada classpath antes:

  

Después de agregar la ruta a la fuente

  

Espero que esto ayude

simplemente actualice el complemento ADT. Eso funcionó para mi !!

  1. Inicie Eclipse, luego seleccione Ayuda> Instalar nuevo software.
  2. Haga clic en Agregar, en la esquina superior derecha.
  3. En el cuadro de diálogo Agregar repository que aparece, ingrese “Complemento ADT” para el Nombre y la siguiente URL para la Ubicación: https://dl-ssl.google.com/android/eclipse/ Nota: El sitio de actualización de las Herramientas para desarrolladores de Android requiere una conexión segura. Asegúrese de que la URL del sitio de actualización que ingrese comience con HTTPS.
  4. Haga clic en Aceptar. En el cuadro de diálogo Software disponible, seleccione la checkbox junto a Herramientas del desarrollador y haga clic en Siguiente.
  5. En la siguiente ventana, verá una lista de las herramientas que se descargarán. Haga clic en Siguiente.
  6. Lea y acepte los acuerdos de licencia, luego haga clic en Finalizar.
  7. Si recibe una advertencia de seguridad que indique que no se puede establecer la autenticidad o validez del software, haga clic en Aceptar.
  8. Cuando la instalación finalice, reinicie Eclipse

¡Espero que ayude!

Para cualquier jar dado, si desea ver la ayuda de Javadoc en la información sobre herramientas durante la encoding, haga lo siguiente: Haga clic con el botón derecho en su proyecto> Propiedades> Ruta de comstackción de Java> Pestaña Bibliotecas. Haga clic en la flecha al lado de su jar para expandir.

El archivo adjunto de origen debe señalar la ubicación del contenedor real (probablemente en su carpeta java).

Ubicación de Javadoc : tiene dos opciones aquí: URL y archivo. Si tus javadocs para este jar están en forma de una carpeta que contiene un archivo index.html en el primer nivel, elige ‘Javadoc URL’ y apunta a esa carpeta. Si sus javadocs están en un contenedor, elija ‘Javadoc in archive’ y señale el contenedor. No olvide reiniciar su área de trabajo / cerrar y vuelva a abrir su proyecto para actualizar la información sobre herramientas con la información de Javadoc.

Espero que esto ayude a dar una respuesta simple para lo que creo que debería ser una tarea muy simple.

Mi solucion:

Descargue un complemento de eclipse llamado: “Característica de Java Source Attacher”.

Más tarde, seleccione un jar y adjunte el código fuente usando este plugin. Haga clic en el archivo jar para seleccionarlo, en el botón derecho del mouse y luego seleccione “attach java source”.

Cuando tienes el código fuente tienes automáticamente el javadoc.

Ahora puede usar F2 sobre las clases para ver el javadoc asociado.

Disfrutar