Javadoc trên Android (Eclipse)

Question

Tôi đang cố gắng tạo các trang html Javadoc cho dự án Android của tôi trong Eclipse. Tôi đã thử sử dụng đối số -linkoffline, dưới dạng suggested here, cũng như sử dụng đối số -classpath trỏ đến tệp android.jar của tôi. Cả hai cách này đều không hoạt động, vì tôi vẫn nhận được cảnh báo package android.app does not exist (và các cảnh báo khác). Tôi cũng đã thử chạy công cụ javadoc từ dòng lệnh, thay vì sử dụng Eclipse.

Lý tưởng nhất là tôi muốn có các trang được tạo riêng cho các lớp học của mình, với tất cả các lớp học android. * Và java. * Liên kết đến các trang trực tuyến. Tôi đang sử dụng Mac OS 10.6 với phiên bản Java 1.6.0_20.

Answer 1

Bạn đã thử sử dụng tập lệnh kiến ​​cho javadocs chưa? Đặt tên cho nó là javadoc.xml hoặc một cái gì đó khác hơn build.xml - khác eclipse sẽ chọn nó làm kịch bản lệnh mặc định. Chạy kịch bản kiến ​​từ bên trong nhật thực (RMB on file | Run As | Ant Build) hoặc từ bảng điều khiển: ant -f <file-name.xml>.

Mine trông tương tự như sau:

<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

Trong khi cố gắng giải quyết một vấn đề tương tự bản thân mình, hai điểm chính tôi đã tìm thấy đã:

• Để bao gồm các android .jar tệp bạn đang liên kết đến trong thuộc tính classpath của nhiệm vụ javadoc Ant. Điều đó có nghĩa giống như sau:

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

• Để thêm một liên kết subitem trong nhiệm vụ javadoc để phù hợp với Reference URL Android trực tuyến với một bản sao cục bộ của Android Reference gói-list. Điều đó có nghĩa giống như sau:

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

Đây là đủ cho tôi để hiển thị liên kết Android trong Javadoc dự án của tôi.