JDK-4689286 : stddoclet: Package link should always be active when document'g only one package
  • Type: Bug
  • Component: tools
  • Sub-Component: javadoc(tool)
  • Affected Version: 1.4.1
  • Priority: P4
  • Status: Closed
  • Resolution: Fixed
  • OS: solaris_9
  • CPU: sparc
  • Submitted: 2002-05-22
  • Updated: 2014-05-05
  • Resolved: 2003-11-23
The Version table provides details related to the release that this issue/RFE will be addressed.

Unresolved : Release in which this issue/RFE will be addressed.
Resolved: Release in which this issue/RFE has been resolved.
Fixed : Release in which this issue/RFE has been fixed. The release containing this fix may be available for download as an Early Access Release or a General Availabitlity Release.

To download the current JDK release, click here.
Other
5.0 b30Fixed
Description
for the following example,
==========================

the files in 

p4359386 directory, a.java and c.java

p4359386/a.java
	/c.java


a.java is
==========

package p4359386;

public class a
{
}

c.java is
=========

package p4359386;

public class c
{
}

do a

javadoc a.java c.java

and observe that the "Package" link is disabled from

deprecated-list.html
index-all.html
help-doc.html
overview-tree.html

whereas it is 'enabled' from

index.html
package-tree.html
a.html
c.html

Though the argument can be that the first four are generic pages, common for most javadoc runs, this introduces a confusing behaviour. The behaviour should be uniform and the std doclet should introduce links uniformly.

Comments
CONVERTED DATA BugTraq+ Release Management Values COMMIT TO FIX: tiger tiger-beta FIXED IN: tiger-beta INTEGRATED IN: tiger-b30 tiger-beta VERIFIED IN: tiger-beta2
2004-06-14

PUBLIC COMMENTS Fixed. ###@###.### 2003-11-15
2003-11-15

EVALUATION This is a bug. He is saying that when you are documenting only a single package, the Package link should always be active, because it is always clear which package is active. The Overview link appears if -overview is passed in, and does not appear if -overview is not passed in. When present, the Overview link is always active -- the Package link would serve a similar purpose. BTW, the correct command is: javadoc p4359386/a.java p4359386/c.java Changed synopsis from: No link to package-summary.html from other htmls to: stddoclet: Package link should always be active when document'g only one package ###@###.### 2002-05-21 ###@###.### also suggests: I think that the package link on all of the general pages (deprecated-list.html, index-all.html, help-doc.html, overview-tree.html) should link to index.html since that is a general package list. We do that on package-tree.html and I think it feels natural. Notice that the "Package" link is highlited on index.html (when the "Overview" link is not present, which happens when only one package is documented). ###@###.### I agree with ###@###.### with one change -- when one package is being documented, the package link on all general pages should link to package-summary.html (not index.html, which is a frameset file and would cause frames to appear if they were off). ###@###.### 2003-09-24 Fixed. ###@###.### 2003-11-15
2003-09-24