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 50279 - Easy way to make package.html (Javadoc for a source package)
Summary: Easy way to make package.html (Javadoc for a source package)
Status: RESOLVED DUPLICATE of bug 36470
Alias: None
Product: java
Classification: Unclassified
Component: Javadoc (show other bugs)
Version: 4.x
Hardware: All All
: P3 blocker (vote)
Assignee: Jan Pokorsky
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2004-10-12 15:06 UTC by pzgyuanf
Modified: 2005-04-29 23:10 UTC (History)
1 user (show)

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 pzgyuanf 2004-10-12 15:06:53 UTC
Many IDE will auto-generate the package-level doc,
i.e. package.html. This file can add something like:
http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#packagecomments.
Comment 1 pzgyuanf 2004-10-12 16:47:13 UTC
At this time, this file(package-summary.html)can generate until
selecting "generate javadoc and cannot add some Description for packages.
Sure, manually adding one package.html file to project directory can
achieve it. 
but why not auto generate it.
Comment 2 Jan Pokorsky 2004-10-13 12:41:27 UTC
So you propose to add package.html as a template (File->New File)?
Comment 3 pzgyuanf 2004-10-13 16:04:09 UTC
I'm sorry I didn't describe it clear.
I think this file, package.html for adding some Description for
package, should be generated as soon as create a new package or (may
be most case) a new project create.
This file actually cannot help a bit, only save someone creating it
manually. a template file isn't needed, because the package
description cannot be auto-added (must be added when package design is ok)
JBuilder auto-generated package.html has one sentence to suggest
developer add something.

you may say: so lazy!
regard.
Comment 4 Jan Pokorsky 2004-10-13 18:33:04 UTC
I see. I can imagine to auto-generate this file while you create a new
package (checkbox with false as default in the package template
wizard). The template of package.html (according to
http://java.sun.com/j2se/javadoc/writingdoccomments/package-template)
would be also useful in case the package already exists.

In case of the new project it does not make sense to me. You do not
know packages that will be added so there is nothing to generate.
Except the case when projects creates new packages.

Reassining since the package wizard is part of the java project.
Comment 5 Jesse Glick 2004-10-13 18:56:47 UTC
I don't think it's a good idea to generate this file when making a new
package; most people won't want it. Possibilities instead:

- Auto Comment tool can suggest that you add one (and make it for you
if you accept)

- special template for package.html, which should be added by the
Javadoc module
Comment 6 pzgyuanf 2004-10-14 04:27:01 UTC
YES, 'most people won't want it' but the doc team or system designer
may want to add some descriptions, how to add it? Manually. Because
the doclet never add like this:
-------------
See:
      Description 
------------ 
in package-summary.html file, Unless there is a package.html file in
the src directory.

I surprisedly find in NetBeans source files, there're these files. Let
see, for
example,netbeans-src\openide\api\doc\org\openide\options\package.html.

Anyway, this is just a propose according to
http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#packagecomments

for IDEs.

Comment 7 Jesse Glick 2005-04-29 23:10:15 UTC

*** This issue has been marked as a duplicate of 36470 ***