Javadoc en Android (Eclipse)

Question

Estoy tratando de generar páginas html Javadoc para mi proyecto de Android en Eclipse. He intentado utilizar el argumento -linkoffline, como suggested here, así como usar el argumento -classpath apuntando a mi archivo android.jar. Ninguno de estos funcionó, ya que todavía recibo package android.app does not exist (y otras) advertencias. También intenté ejecutar la herramienta javadoc desde la línea de comandos, en lugar de usar Eclipse.

Idealmente me gustaría tener mis propias páginas generadas para mis clases, con todas las clases de android. * Y java. * Que enlazan a las páginas en línea. Estoy usando Mac OS 10.6 con Java versión 1.6.0_20.

Answer 1

¿Has probado con un script ant para los javadocs? Nómbrelo javadoc.xml o algo distinto de build.xml - else eclipse lo recogerá como el script de compilación predeterminado. Ejecute el script de la hormiga desde eclipse interno (RMB on file | Run As | Ant Build) o desde la consola: ant -f <file-name.xml>.

mina se ve algo similar a esto:

<project basedir="." default="doc" name="metagloss api docs"> 

    <property 
     name="android-sdk-docs" 
     value="/home/blackrax/opt/dev/android-sdk-linux_86/docs/reference"/> 

    <target name="doc" description="api docs - no piwik" depends="clean, delombok"> 
     <javadoc destdir="docs"> 
      <link offline="true" 
        href="http://d.android.com/reference" 
        packagelistLoc="${android-sdk-docs}" /> 
      <fileset dir="src" includes="**/*.java" /> 
     </javadoc> 
    </target> 

    <!-- more implementation, any remaining targets --> 
</project> 

Answer 2

Al tratar de resolver un problema similar a mí mismo, los dos puntos principales que he encontrado han sido:

• para incluir el androide .jar archivo que está vinculando dentro del atributo classpath de la javadoc tarea Ant. Eso quiere decir algo como lo siguiente:

  <javadoc ... 
      classpath="some/local/library.jar; 
      C:/Android/platforms/android-8/android.jar; 
      D:/another/library.jar" ... > 
  

• Para agregar un enlace subtema bajo tarea javadoc con el fin de que coincida con la URL de referencia Android en línea con una copia local de Android Referencia paquete de lista. Eso quiere decir algo como lo siguiente:

  <javadoc ...> 
      <link offline="true" 
      href="http://developer.android.com/reference/" 
      packagelistloc="C:/Android/docs/reference" /> 
  </javadoc> 
  

Esto fue suficiente para mí con el fin de mostrar enlaces Android dentro de mi proyecto de Javadoc.