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

javadoc template: Add automatic link capability within descriptions

XMLWordPrintable

    • Icon: Enhancement Enhancement
    • Resolution: Duplicate
    • Icon: P5 P5
    • None
    • 1.1, 1.1.3
    • tools
    • generic, x86
    • solaris_2.5.1, windows_95

      It would be useful to add an option to javadoc (-autolink ?) to automatically generate links for API appearing in descriptions. It might work like this:
      Here's a description:

      /**
       * This method uses a <code>Date</code> instance for dates
       * and a <code>Time</code> instance for times.
       *
       * @see java.util.Date java.util.Time
       */

      The presence of <code> in the description signals that this word
      be matched by the same word in the @see line. This would generate
      the following HTML:

      This method uses a <code><a href="java.util.Date.html">Date</a></code>
      instance for dates and a <code><a href="java.util.Time.html">Time</a></code>
      instance for times.

      Advantage: Adding links in the description is automatic, and the
      <code> tags do not appreciably clutter the text.

      We could use <tt>...</tt> instead of <code>...</code> as an explicit tag
      to indicate "attach a link here from the @see list".

            dkramersunw Douglas Kramer (Inactive)
            duke J. Duke
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

              Created:
              Updated:
              Resolved:
              Imported:
              Indexed: