Javadoc su Android (Eclipse)

Question

Sto cercando di generare pagine html Javadoc per il mio progetto Android in Eclipse. Ho provato a utilizzare l'argomento -linkoffline, come suggested here, nonché a utilizzare l'argomento che punta al mio file android.jar. Nessuno di questi ha funzionato, poiché ricevo ancora gli avvertimenti package android.app does not exist (e altri). Ho anche provato a eseguire lo strumento javadoc dalla riga di comando, piuttosto che usare Eclipse.

Idealmente mi piacerebbe avere le mie pagine generate per le mie classi, con tutte le classi di android. * E java. * Che collegano alle pagine online. Sto usando Mac OS 10.6 con Java versione 1.6.0_20.

Answer 1

Hai provato a utilizzare uno script ant per i javadoc? Denominalo javadoc.xml o qualcosa di diverso da build.xml - altrimenti eclipse lo prenderà come script di compilazione predefinito. Esegui lo script ant dall'interno di eclissi (RMB on file | Run As | Ant Build) o dalla console: ant -f <file-name.xml>.

Miniera sembra qualcosa di simile a questo:

<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

Durante il tentativo di risolvere un problema simile me stesso, i due punti principali che ho trovato sono stati:

• per includere il Android .jar file a cui si sta collegando l'attributo classpath nell'attività javadoc Ant. Ciò significa che qualcosa di simile a quanto segue:

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

• Per aggiungere un collegamento elemento secondario sotto compito javadoc al fine di corrispondere alla linea Android URL di riferimento con una copia locale di riferimento Android pacchetto-list. Ciò significa che qualcosa di simile a quanto segue:

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

Questo è stato sufficiente per me al fine di mostrare i collegamenti Android all'interno del mio progetto Javadoc.