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

Add @xref doc-comment tag (similar to @link)

XMLWordPrintable

    • Icon: Enhancement Enhancement
    • Resolution: Duplicate
    • Icon: P5 P5
    • None
    • 1.1
    • tools

      Especially when javadoc is once again used to generate hardcopy documentation (such as -doctype MIF), it would be useful to add a doc-comment tag that translates into the appropriate target code a cross reference. The syntax would look something like:

      @xref(text, reference)

      For example:

      /**
      * An instance of a @xref(scroll bar, ScrollBar) is ...
      */

      would generate FramkeMaker output such as:

      An instance of a scroll bar (S5.3.2) is ...

      and would generate HTML output such as:

      An instance of a <a href="ScrollBar">scroll bar</a> is ...

      Note that "(..., ...)" is a new syntax for doc-comment tags. Consequently, care must be taken to ensure that the simplest, but most extensible format is chosen.



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

              Created:
              Updated:
              Resolved:
              Imported:
              Indexed: