Incidently the commant I use to generate the API is as follows:
javadoc -public -windowtitle "iSmart Server API Specification" -header "<B>iSmart Server API</B>" -bottom "<font size='-1'>Copyright 2002 eSpatial, Inc. Reproduction is forbidden unless authorized.
Please contact eSpatial to <A HREF="mailto:bugs@eSpatial.com">Submit a Bug or Feature.</A></font>" -classpath .;C:\JDev9r2\j2ee\home\lib\ejb.jar;C:\JDev9r2\j2ee\home\lib\sdoapi.zip;C:\JDev9r2\j2ee\home\lib\ordim817.zip;C:\JDev9r2\j2ee\home\lib\classes12.jar -d c:\temp\java\javadoc ess.sis.common ess.sis.server ess.sis.viewer ess.sis.editor ess.topology
There's currently no option to put the text above the table.
We have an open request at:
4649116: Add option to include full package description at top, before interface table
<http://developer.java.sun.com/developer/bugParade/bugs/4649116.html>
Perhaps we'll be able to get to this in the next version.
If you are adventuresome, you could download the source release
and make a small change to the source code. In the following code,
make the noted change, moving "printPackageDescription()" up one
line, ahead of generateClassListing().
com.sun.tools.doclets.standard.AbstractPackageWriter.java
/**
* Generate Individual Package File with Class/Interface/Exceptions and
* Error Listing with the appropriate links. Calls the methods from the
* sub-classes to generate the file contents.
* @param includeScript boolean true when including windowtitle script
*/
protected void generatePackageFile(boolean includeScript) throws IOException {
String pkgName = packagedoc.name();
String metakeywords = pkgName + " " + getText("doclet.package");
printHtmlHeader(pkgName, metakeywords, includeScript);
printPackageHeader(pkgName);
generateClassListing();
printPackageDescription(); // Move this statement up one line
printPackageFooter();
printBodyHtmlEnd();
}
-Doug Kramer
Javadoc team