RE: javadoc ?s

Subject: RE: javadoc ?s
From: David Price <price -at- ontos -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Fri, 18 May 2001 18:32:54 -0400

> I skimmed Sun's FAQ but couldn't find info on how to populate
> the top-right
> header (for API identification) and first two lines under the
> header of
> overview-summary.html

For the top-right header, use the -header option when you compile javadoc.
You can use HTML formatting. For the overview text, use the -overview
option and specify an HTML file you want to import. You'll need to put that
file in every directory for which you want an overview. It must be named
the same in each directory. Example:

REM Set the header & footer -- VERSION/COPYRIGHT/ID INFO
SET HEADER="<b>Your_product </b><font size='-1'>v4.5</font><br><font
size='-1'><a href=''
SET FOOTER="<b>Your_product </b><font size='-1'>v4.5</font><br><font
SET BOTTOM="<font size='-2'>Copyright 2001 Your Company</font>"

REM the javadoc directory must exist - create it if it doesn't
IF NOT EXIST javadoc md javadoc

REM Run the command with options
javadoc -windowtitle "Your_product Java API" -d javadoc -header %HEADER%
-bottom %BOTTOM% -footer %FOOTER% -overview overview.html -stylesheetfile
ontosjdoc.css -nodeprecatedlist -doctitle "Your_product JavaDoc" -classpath
"%jars%" com.your_product.dsl.base com.your_product.dsl.objs

For full-text search, you just need something that'll search straight HTML
-- maybe others can suggest products.


- David


*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available now at or info -at- devahelp -dot- com

Sponsored by Information Mapping, Inc., a professional services firm
specializing in Knowledge Management and e-content solutions. See or 800-463-6627 for more about our solutions.

You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit for more resources and info.


Previous by Author: RE: API/javadoc - classes/methods that should not be public
Next by Author: RE: Online Help development for Mac platform
Previous by Thread: javadoc ?s
Next by Thread: RE: javadoc ?s

What this post helpful? Share it with friends and colleagues:

Sponsored Ads