Ошибка создания javadoc проекта Android с помощью Doclava

Я пытаюсь создать документацию по моему проекту Android, используя javadoc и doclava. Я скачал банку doclava и пытаюсь сгенерировать документ через Project-> generate javadoc.

Если я понял механизм, у меня есть два способа сообщить javadoc использовать доклет doclava:

1) Выберите «использовать пользовательский доклет» со следующими параметрами:

Имя доклета: com.google.doclava.Doclava
Путь доклета: /full/path/of/my/doclava/dir/doclava-1.0.6.jar

2) Выберите «использовать стандартный доклет», а затем в «параметрах javadoc» введите:

-doclet com.google.doclava.Doclava
-docletpath ${/full/path/of/my/doclava/dir/doclava-1.0.6.jar}

Я столкнулся с этими проблемами:

  • Если я использую первый метод, я могу успешно сгенерировать документ, но кажется, что классы Android не распознаются. Я получаю ошибки, когда doclava анализирует «import android.util.SparseArray»

  • Если я использую второй метод, я получаю эту ошибку: «javadoc: ошибка — не удается найти класс doclet com.google.doclava.Doclava 1 ошибка»

На самом деле: если я не использую Doclava, моя документация генерируется правильно со ссылками на Android API.

Я просто хочу создать свой проект javadoc со ссылками на документ android/java (для объектов android/java) и иметь «внешний вид Android».


android javadoc doclet
person The Good Giant    schedule 05.04.2013    source источник

Ответы (1)


arrow_upward
6
arrow_downward

Для тех, кто интересуется темой, я решил свою проблему, используя первое решение, вот используемая цель муравья:

<target name="build-javadoc">
    <echo message="Creating Javadoc.." />
    <delete dir="${doc.dir}" />
    <javadoc    access="public" 
                destdir="${doc.dir}" 
                sourcepath="${src.dir}" 
                docletpath="${doclet.dir}/doclava-1.0.6.jar" 
                classpath="lib:libs:/Users/myusername/android-sdks/platforms/android-17/android.jar" 
                packagenames="com.my.package">


        <doclet name="com.google.doclava.Doclava">
            <!-- Title -->
            <param name="-hdf" />
            <param name="project.name" />
            <param name="Project Name" />

            <!-- Overview -->
            <param name="-overview" />
            <param name="src/overview-summary.html" />

            <!-- Template -->
            <param name="-templatedir" />
            <param name="Doc/My_Template" />

            <!-- federation Java -->
            <param name="-federate" />
            <param name="JDK" />
            <param name="http://download.oracle.com/javase/6/docs/api/index.html?" />
            <param name="-federationxml" />
            <param name="JDK" />
            <param name="http://doclava.googlecode.com/svn/static/api/openjdk-6.xml" />

            <!-- federation Android-->
            <param name="-federate" />
            <param name="android" />
            <param name="http://d.android.com/reference" />
            <param name="-federationxml" />
            <param name="android" />
            <param name="http://doclava.googlecode.com/svn/static/api/android-8.xml" />

        </doclet>
    </javadoc>

    <echo message="...Done" />
</target>

Надеюсь, это может помочь кому-то

person The Good Giant    schedule 25.07.2013
comment
Ссылки на федерацию не работают. Есть ли обновленные ссылки на текущие файлы доклавы Android? - person najm; 04.07.2020