Javadoc sur Android (Eclipse)

Question

J'essaie de générer des pages Javadoc html pour mon projet Android dans Eclipse. J'ai essayé d'utiliser l'argument -linkoffline, comme suggested here, ainsi que l'argument -classpath pointant vers mon fichier android.jar. Aucun d'entre eux n'a fonctionné, car je reçois toujours package android.app does not exist (et autres) avertissements. J'ai également essayé d'exécuter l'outil javadoc à partir de la ligne de commande, plutôt que d'utiliser Eclipse.

Idéalement, je voudrais avoir mes propres pages générées pour mes cours, avec toutes les classes android. * Et java. * Reliant aux pages en ligne. J'utilise Mac OS 10.6 avec Java version 1.6.0_20.

Answer 1

Avez-vous essayé d'utiliser un script ant pour les javadocs? Nommez-le javadoc.xml ou autre chose que build.xml - sinon eclipse le récupérera comme script de construction par défaut. Exécutez le script ant de l'intérieur de eclipse (RMB on file | Run As | Ant Build) ou depuis la console: ant -f <file-name.xml>.

mine ressemble à quelque chose semblable à ceci:

<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

Tout en essayant de résoudre un problème similaire moi-même, les deux principaux points que j'ai trouvé ont été:

• Pour inclure le android .jar fichier que vous liez dans l'attribut classpath de la tâche javadoc Ant. Cela signifie quelque chose comme ce qui suit:

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

• Pour ajouter un lien sous-élément sous la tâche javadoc afin de correspondre à la ligne Android URL de référence avec une copie locale du paquet-list Android Référence . Cela signifie quelque chose comme ce qui suit:

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

Cela me suffit était pour pour afficher des liens Android dans mon projet Javadoc.