2011-12-20 11 views
17

¿Cómo generar javadoc personalizado para el paquete de compatibilidad android 1.4?¿Cómo instalar javadoc para el paquete de compatibilidad de Android?

Los documentos de referencia están disponibles en línea (example), pero ¿hay algún lugar donde pueda obtener un código postal con javadoc disponible sin conexión?

Supongo que usar javadoc sería bastante simple, solo es cuestión de establecer la ubicación de javadoc para el jar de compatibilidad.

Respuesta

28

Puede generar su javadoc fuera de línea por su cuenta desde el código fuente. Simplemente vaya a su directorio SDK de Android a continuación, haga lo siguiente

cd <path_to_android_sdk>/extras/android/compatibility/v4/ 
mkdir docs 

Para Windows:

javadoc -d docs -sourcepath src\java -subpackages android.support.v4 

Para Linux/Mac:

javadoc -d docs -sourcepath src/java -subpackages android.support.v4 

Esto generará sus javadocs para usted a nivel local en el docs directorio que acaba de crear.

Luego, en su proyecto de Eclipse para Android, vaya a las propiedades de su proyecto donde agregó el android-support-v4.jar, edite sus propiedades y agregue la ruta a los javadocs que acaba de crear.

¡Eso debería funcionar!

ADT 17+ cuestiones:

Como algunos de ustedes han señalado. Ha habido problemas para que Eclipse vea el javadoc adjunto para ADT 17+. Este es un problema conocido y se ha presentado un error. Esto no está relacionado con la forma en que genera el javadoc (como describí anteriormente), sino que este es un problema con ADT 17+ que se integra con Eclipse. Alguien ha descrito una solución y puede ser seguido aquí:

http://code.google.com/p/android/issues/detail?id=28801

+0

su 'src/java' en un mac. w00p w00p ty – Blundell

+0

** NOTA: ** desde ADT 17, esta solución ya no funciona. [Fuente] (http://code.google.com/p/android/issues/detail?id=28801) –

+0

Aún puede generar la multa de javadoc utilizando lo que escribí anteriormente (que era el propósito de la pregunta). Si hay problemas con Eclipse y ADT que ahora le permiten verlo dentro del IDE, ese es otro problema que debe resolverse. ¡Gracias por señalarlo! es bueno saber – wnafee

2

La respuesta por @wnafee en el clavo, pero si usted está usando Linux no se olvide de utilizar el carácter de barra diagonal en este lugar como src/java.

12

Problema: Si elandroid-support-v4.jar se encuentra en la carpeta /libs (como requiere el ADT 17+) el Javadoc no está disponible.


Editar: He workarounded el problema mediante la vinculación de la versión sin conexión de la javadoc Android para el androide-support-v4.jar. Hasta donde yo sé, todavía no es posible vincular la versión en línea (http://developer.android.com/reference). Pasos:

  1. Descargue la documentación para Android SDK del SDK Manager. Puede encontrarlo en la última versión de Android (4.1)
  2. Enlace la carpeta javadoc a la carpeta de su proyecto, en Windows abrir una consola y escribir: MKLINK /J {PROJECT_PATH}\android_docs {SDK_PATH}\docs\reference
  3. Crear el archivo libs/android-support-v4.jar.properties con este contenido:

    src=android-support-v4.jar 
    doc=../android_docs 
    
  4. Cierre el proyecto y volver a abrirlo. Limpie si es necesario.

  5. El javadoc está vinculado. Comprobarlo yendo a cualquier clase de biblioteca de soporte, como android.support.v4.app.FragmentActivity

Gracias a esta respuesta https://stackoverflow.com/a/11579339/933261

+0

Aún puede generar el javadoc desconectado para verlo en un navegador o manualmente. Está describiendo un problema al conectarlo a su IDE para facilitar la experiencia de codificación. – wnafee

+0

Esto es fijo/incorrecto: http://stackoverflow.com/questions/9873152/how-to-attach-javadoc-or-sources-to-jars-in-libs-folder (para mí, también tuve que reiniciar eclipse after, Y mantenga los documentos en la misma unidad) – pjco

+0

Votó por última vez, para una edición útil – pjco

2

si estás en Windows y se atascan durante siglos como yo, hacer Seguro que escaparas de tus bloqueos en el archivo de propiedades, o las cosas fallarán en silencio. (Que hace que fallan cargadores silenciosas de todos modos ...)

esto, esto es mi archivo de propiedades:

src=android-support-v4.jar 
doc=doc\\android-support-v4_doc 

y mi dir es el siguiente:

android-support-v4.docs.zip 
android-support-v4.jar 
android-support-v4.jar.properties 
doc 

cierre del proyecto y abierta, y todo funciona para mi

0

Revisé todas estas soluciones y ninguna de ellas funcionó. Aquí es lo que hice para conseguir que funcione:

  1. Vaya a la carpeta siguiente: D: \\ android-sdk-windows-Android SDK \ \ extras \ androide \ support \ v4

  2. ejecute el comando: -d javadoc docs -sourcepath src \ java -subpackages android.support.v4

  3. En el directorio libs de su proyecto, crear un archivo llamado android-support-v4.jar.properties

  4. En el archivo de propiedades, agregue las siguientes líneas (cambie la ruta para que coincida con la suya):

    doc = D: \ Archivos de programa \ Android-SDK \ android-sdk-windows \ extras \ android \ support \ v4 \ docs src = D: \ archivos de programa \ Android-SDK \ android-sdk-windows \ extras \ \ support androide \ v4 \ src

  5. En Eclipse, abrir el diálogo de propiedades para la construcción, a continuación, vaya a Java Build Ruta y seleccione la pestaña Bibliotecas.

  6. Expanda la biblioteca de soporte. En mi caso, la ruta es: D: \ Archivos de programa \ Android-SDK \ android-sdk-windows \ extras \ android \ support \ v4

  7. Seleccione la ubicación de Javadoc. Haga clic en el botón Editar y luego seleccione la ruta a los documentos. En mi caso fue: file:/D:/Archivos de programa/Android-SDK/android-sdk-windows/extras/Android/soporte/v4/docs/

  8. Cerrar todo, incluyendo Eclipse y reinicie. Ahora debería poder navegar por los documentos en su código.

Cuestiones relacionadas