This Bugzilla instance is a read-only archive of historic NetBeans bug reports. To report a bug in NetBeans please follow the project's instructions for reporting issues.

Bug 73359 - Integration of overview.html
Summary: Integration of overview.html
Status: NEW
Alias: None
Product: java
Classification: Unclassified
Component: Javadoc (show other bugs)
Version: 5.x
Hardware: All All
: P3 blocker (vote)
Assignee: Jan Becicka
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2006-03-07 22:57 UTC by dylanpierce
Modified: 2010-09-23 08:36 UTC (History)
0 users

See Also:
Issue Type: ENHANCEMENT
Exception Reporter:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description dylanpierce 2006-03-07 22:57:39 UTC
In the current Javadoc specification, it is suggested that the file
"overview.html," used in generating Javadoc documentation, be placed at the base
of the source tree. In the IDE, this shows up as being in the "<default
package>" and in the file system, under the directory "src".

However, when one compiles Javadoc (or sets the properties for it), the overview
field requires an absolute path which must be set manually in every project.
While it is desirable to be able to place any path at all (especially in the
case of multiple overview files for different target audiences), it would also
be nice to see default behavior of recognizing a standard overview file in the
standard location. That way, even if the location of the project folder moves,
default behavior still compiles the Javadoc as desired.

It might also be nice if the IDE recognized "overview.html" as not just any HTML
file, but a specific JavaDoc file with a ready-made template and editing
features (especially with regards to Javadoc tags). The template part is easy,
of course. The specialized editing part, perhaps not so much.