Javadoc на Android (Затмение) - PullRequest
Новая
       12

Javadoc на Android (Затмение)

5 голосов
/ 27 июля 2010

Я пытаюсь сгенерировать HTML-страницы Javadoc для моего проекта Android в Eclipse. Я попытался использовать аргумент -linkoffline, как предложил здесь , а также аргумент -classpath, указывающий на мой файл android.jar. Ни один из них не сработал, так как я все еще получаю package android.app does not exist (и другие) предупреждения. Я также попытался запустить инструмент javadoc из командной строки, а не использовать Eclipse.

В идеале я хотел бы иметь свои собственные сгенерированные страницы для своих классов со всеми классами android. * И java. *, Ссылающимися на онлайн-страницы. Я использую Mac OS 10.6 с Java версии 1.6.0_20.

Ответы [ 2 ]

3 голосов
/ 13 сентября 2011

Пытаясь решить подобную проблему самостоятельно, я обнаружил два основных момента:

  • Чтобы включить файл android.jar , на который вы ссылаетесь, в атрибут classpath задачи javadoc Ant. Это означает что-то вроде следующего: 

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

  • Чтобы добавить подпункт ссылка в задачу javadoc, чтобы сопоставить онлайновый URL-адрес ссылки на Android с локальной копией Android-справки package-list . Это означает что-то вроде следующего: 

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

Этого мне было достаточно, чтобы показывать ссылки Android в моем проекте Javadoc.

1 голос
/ 08 ноября 2010

Вы пытались использовать муравей скрипт для javadocs?Назовите его javadoc.xml или что-то отличное от build.xml - иначе eclipse выберет его в качестве сценария сборки по умолчанию.Запустите скрипт ant изнутри eclipse (RMB on file | Run As | Ant Build) или из консоли: ant -f <file-name.xml>.

Мой выглядит примерно так: 

<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>
...