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

Add @tutorial tag for linking to the Java Tutorial

XMLWordPrintable

    • Icon: Enhancement Enhancement
    • Resolution: Won't Fix
    • Icon: P5 P5
    • tbd
    • 1.2.0, 5.0
    • tools
    • x86, sparc
    • solaris_2.5, windows_xp

      Developers need access to examples from javadoc pages.
      The way JavaSoft provides examples is via the Java Tutorial.
      Therefore we should formalize a way to link to the tutorial.
      A standalone tag should be sufficient.
      Suggest adding @tutorial tag:

        SYNTAX: @tutorial relativepath text
        EXAMPLE: @tutorial i18n/index.html Internationalization Tutorial

          where "relativepath" is the known path to the tutorial from
          some root to be specified on the javadoc command line.

      This link would point either to the JavaSoft website or to
      a local drive, depending on the root:

      1) javadoc -tutorialpath "http://java.sun.com/docs/books/tutorial"

         would generate:
         <a href="http://java.sun.com/docs/books/tutorial/i18n/index.html">

      2) javadoc -tutorialpath "../tutorial"

         would generate:
         <a href="../tutorial/i18n/index.html">

            bpatel Bhavesh Patel (Inactive)
            dkramersunw Douglas Kramer (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved:
              Imported:
              Indexed: