JDK-4368820 : stddoclet: Inherited comment should link directly to member, not just class
  • Type: Bug
  • Component: tools
  • Sub-Component: javadoc(tool)
  • Affected Version: 1.2.0
  • Priority: P4
  • Status: Resolved
  • Resolution: Fixed
  • OS: solaris_2.6
  • CPU: sparc
  • Submitted: 2000-09-06
  • Updated: 2020-08-31
  • Resolved: 2003-11-11
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 Availability Release.

To download the current JDK release, click here.
Other
5.0 b28Fixed
Description
When a member inherits a comment, it provides a link to the class or interface it inherits from -- this link should be to the exact member in that class or interface.

For example, the itemStateChanged method appears as follows:

http://java.sun.com/products//jdk/1.2/docs/api/javax/swing/DefaultCellEditor.EditorDelegate.html#itemStateChanged(java.awt.event.ItemEvent)

----------------------------------------------------------------
itemStateChanged

public void itemStateChanged(ItemEvent e)

      Description copied from interface: ItemListener 
      Invoked when an item has been selected or deselected. The code written 
      for this method performs the operations that need to
      occur when an item is selected (or deselected).
------------------------------------------------------------------

The link for ItemListener currently is this:
<B>Description copied from interface: <A HREF="../../java/awt/event/ItemListener.html">ItemListener</A></B>

but should instead link directly to the inherited comment:
<B>Description copied from interface: <A HREF="../../java/awt/event/ItemListener.html#itemStateChanged(java.awt.event.ItemEvent)">ItemListener</A></B>

Notice the label "ItemListener" should *not* be lengthened to  "ItemListener.itemStateChanged", as this is unnecessary text to read.


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

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

EVALUATION Do it. ###@###.### 2002-12-14 Fixed. ###@###.### 2003-10-11
14-12-2002