Android'deki Javadoc (Eclipse)

Question

Eclipse'deki Android projem için Javadoc html sayfaları oluşturmaya çalışıyorum. Benim android.jar dosyasına işaret eden -classpath argümanını kullanarak -linkoffline argümanını, suggested here kullanmayı denedim. Bunlardan hiçbiri, hala package android.app does not exist (ve diğer) uyarıları aldığım için işe yaramadı. Ayrıca Eclipse kullanmak yerine javadoc aracını komut satırından çalıştırmayı denedim.

İdeal olarak, online sayfalara bağlanan tüm android. * Ve java. * Sınıfları ile sınıflarım için kendi oluşturulmuş sayfalarma sahip olmak isterim. Mac.0 10.6 Java sürümü 1.6.0_20 ile kullanıyorum.

Answer 1

Javadocs için bir ant komut dosyası kullanmayı denediniz mi? javadoc.xml ya da build.xml'dan başka bir ad verin - aksi halde eclipse varsayılan yapı betiği olarak alır. Karınca komut dosyasını hem iç tutulması (RMB on file | Run As | Ant Build) hem de konsoldan (ant -f <file-name.xml>) çalıştırın.

Mine buna benzer bir şey arar:

<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

benzer konuyu kendim çözmeye çalışırken, ben olmuştur buldum iki ana nokta:

• android dahil etmek .jar dosyası, javadoc Ant görevinin classpath özniteliğine bağlanır.

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

• Android Referans paket listesinin yerel bir kopyası ile çevrimiçi Android Referans URL eşleşmesi için javadoc görev altında bağlantı alt öğesi eklemek için: Bu aşağıdaki gibi ifade eder.

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

Bu benim projem Javadoc içinde Android bağlantılarını göstermek için benim için yeterliydi: Bu aşağıdaki gibi bir anlama gelir.