(Answer) (Category) FAQ-O-Matic : (Category) JBuilder 6 General :
I want to provide an overview section in my project's JavaDoc, but I can't figure out where to put the html file where the JavaDoc wizard can find it.
Bill Joy of Borland writes:

I experimented with this. I put an HTML file at the root of my project source directory. I added a

 -overview MySummary.html

in the "additional options" of the Javadoc Wizard (in the Doclet options page). I right-clicked on the Javadoc node in the Project Pane and did a Make. I double-clicked on the index.html node under the Javadoc node.

The index.html page was generated with an "Overview" at the top of the page (next to the normal "Package" and "Class"), and all the HTML pages for the individual classes had an "Overview" hyperlink. At the bottom of the index.html was the actual content of MySummary.html. Looking at the source of index.html, I can see that allclasses-frame.html and overview-summary.html are being shown by index.html in separate frames.

Here is the Sun documentation:

"Specifies that javadoc should retrieve the text for the overview documentation from the "source" file specified by path\filename and place it on the Overview page (overview-summary.html). The path\filename is relative to the -sourcepath. "
"While you can use any name you want for filename and place it anywhere you want for path, a typical thing to do is to name it overview.html and place it in the source tree at the directory that contains the topmost package directories. In this location, no path is needed when documenting packages, since -sourcepath will point to this file."

http://java.sun.com/products/jdk/1.2/docs/tooldocs/win32/javadoc.html

2002-Apr-15 6:54am gyles19@visi.com

[Append to This Answer]
2002-Apr-15 6:54am
Previous: (Answer) I'm trying to create a GUI with the Designer, and my GUI uses JDK 1.4's new logging api. When I try to open the GUI in the designer, I get a class java.lang.SecurityException Prohibited package name: java.util.logging exception.
Next: (Answer) License corrupt
This document is: http://www.visi.com/~gyles19/cgi-bin/fom.cgi?file=384
[Search] [Appearance]
This is a Faq-O-Matic 2.709.
This FAQ administered by gyles19@visi.com.

Other JBuilder Links

Java Community
Java Tools
Code Central
JB OpenTools
Community
Recent
Threads
Borland Chat
Chat FAQ
Feature Matrices
3.0 |  3.5 |  4.0
5.0 |  6.0 |  7.0
Shop for
JBuilder
JBuilder
Downloads
and reg keys
Report Piracy
Online Manuals
4.0 |  5.0 |  6.0
7.0
Borland
DevSupport's
Bug/RFE Form

Quality Central Client
JB Patches &
Updates
JBuilder FAQs TIs
JBuilder
Newsgroups
Tamaracka's
News Archive
Mr. Haki's
JBuilder Machine
JGuru's
JBuilder FAQ
Sun's Bug
Parade
Netring Home - About - Privacy
The
JBuilder Netring Logo
The Borland JBuilder Netring by JBuilder FAQ-O-Matic
[ Join Now | List Sites | Random | << Prev | Next >> ]
[ Previous 5 Sites | Skip Previous | Skip Next | Next 5 Sites ]