|
|
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. "
http://java.sun.com/products/jdk/1.2/docs/tooldocs/win32/javadoc.html | |
| [Append to This Answer] | |
| 2002-Apr-15 6:54am |
| ||||||||
|
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 |
|||||||||||||||||
|
|||||||||||||||||