Where's the documentation for the JavadocTool programmatic interface?

Question

To be clear, I'm not talking about the output of javadoc -help; I'm interested in using the JavadocTool class from Java code.

According to the Javadoc FAQ, I should be able to find the source code (and hopefully the docs). Unfortunately, that link points to the generic "Oracle acquired Sun" page. I'm actually less interested in the source code than better documentation on the "JavadocTool" class as compared to what's provided by OpenJDK at docjar.com:

http://www.docjar.com/docs/api/com/sun/tools/javadoc/JavadocTool.html

Specifically, I'd like to know more about the getRootDocImpl method. NOTE - I'm neither talking about the command line interface, nor the Doclet API.

Answer 1

So, in large part, one can read the documentation for the command line tool and infer what getRootDocImpl is going to do with its arguments. I say in large part because I initially tried passing options via getRootDocImpl's "options" argument, but found that I needed to use a com.sun.tools.javac.util.Options object instead.

Further, Tobias Kortkamp was kind enough to have sent me an example. There, you can see that use of com.sun.tools.javac.util.Options I referred to earlier.

Answer 2

Try http://docs.oracle.com/javase/1.5.0/docs/guide/javadoc/index.html. Seems to be a reasonable hub for javadoc stuff.