Javadoc HTML document to contain external package information

Question

Hi there:
I would like to know how to issue the proper command line to generate a javadoc html document containing external packages. I found the the -group option, can anyone provide some insights to this?
I have one java source that use java.sql package, I like to be able to generated the html document to show everything associated with the java.sql package in addition to my own java program.
Thanks, Joseph

Answer 1

There are two ways to do this: (most people use the second approach)
1) Include package and class pages for both your packages and the java.sql.package This requires that you have the java.sql
source files and run javadoc on them both:
javadoc -d docs -sourcepath <paths> com.yourpackage java.sql
where <paths> is the paths to your package and java.sql
source files (semi-colon separated on Windows).
To get the source files for java.sql you might be able to use
the source files in src.zip that comes with the J2SDK, but
the package.html file is not included. You could re-construct
that from the HTML page on our website (remove the table of
classes from overview-summary.html), or just get the entire
source release from:
http://java.sun.com/j2se/javadoc/faq/index.html#sourcecode
which has the complete source code.
2) Include package and class pages for only your packages, and
just links to existing java.sql documentation.
javadoc -d docs -link <URL> -sourcepath <path> com.yourpackage
where <URL> is http://java.sun.com/j2se/1.4/docs/api
and <path> is the path to your source files.
If your terminal window cannot ping that URL, then you must
copy package-list from that location to your local drive and
use -linkoffline instead (look up in the docs).
-Doug Kramer
Javadoc team