Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-4368820

stddoclet: Inherited comment should link directly to member, not just class

    XMLWordPrintable

Details

    • b28
    • sparc
    • solaris_2.6

    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.

      Attachments

        Activity

          People

            jhosunw Jamie Ho (Inactive)
            dkramersunw Douglas Kramer (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:
              Imported:
              Indexed: