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 151906 - recognition of overview.html when building javadoc
Summary: recognition of overview.html when building javadoc
Status: NEW
Alias: None
Product: java
Classification: Unclassified
Component: Project (show other bugs)
Version: 6.x
Hardware: Macintosh All
: P3 blocker (vote)
Assignee: Tomas Zezula
Depends on:
Reported: 2008-10-30 20:59 UTC by sean
Modified: 2011-08-31 14:08 UTC (History)
0 users

See Also:
Exception Reporter:


Note You need to log in before you can comment on or make changes to this bug.
Description sean 2008-10-30 20:59:10 UTC
When creating javadoc, NB currently does not recognize overview.html as the overview file.  It would also be very handy
for NB to recognize the existence of overview.html and include that in the javadoc rather than requiring the developer
to copy the javadoc section from build-impl.xml and insert it into build.xml with an extra attribute to force
overview.html's inclusion.

For Java ME builds, it is important that this file is NOT automatically placed in the JAD/JAR - see 151905.
Comment 1 Petr Suchomel 2008-11-22 10:47:15 UTC
How the entire NetBeans handle this? Tim could you look?
Comment 2 _ tboudreau 2008-11-25 08:06:41 UTC

In nbproject/

AFAIK there is no standard location or naming convention for this file, since it can reside anywhere in the project (or
even outside its file tree), unlike package.html which are tied to java packages.  For all of my projects in which I've
ever had an overview page, I had to manually modify the

It wouldn't be a bad thing to have a default location (say, the project root) for the overview file;  however, that
should be taken care of for all java project types, not just mobility.  Turning this issue into an enhancement to the
java module.  The change would be pretty simple - just add javadoc.Overview=overview.html to expect it in the project
root.  If folks there agree, we can make a similar change in the mobility project modules.