Error creating javasdroid project using Doclava

Question

I am trying to create documentation for my Android project using javadoc and doclava. I downloaded the doclava jar and I am trying to create a doc via Project-> generate javadoc.

If I understand the mechanism, I have two ways to tell javadoc to use the docava doclet:

1) Select "use custom document" with these options:

Doclet Name: com.google.doclava.Doclava
Doclet Path: /full/path/of/my/doclava/dir/doclava-1.0.6.jar

2) Select "use standard doclet", and then in the "javadoc options" parameters, put:

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

I ran into these problems:

• If I use the first method, I can successfully generate the document, but it seems that the Android classes are not recognized. I get errors when doclava parses "import android.util.SparseArray"

• If I use the second method, I get this error: "javadoc: error - Cannot find class doclet com.google.doclava.Doclava 1 error"

Actually: if I do not use Doclava, my documentation is correctly generated with links to android apis.

I just want to create my javadoc project with links to the android / java file (for android / java objects) and have an “Android look”.

Answer 1

For those who are interested in the topic, I solved the problem using the first solution, ant target is used here:

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

Hope this can help someone