JDK-4125834 : Add @tutorial tag for linking to the Java Tutorial
  • Type: Enhancement
  • Component: tools
  • Sub-Component: javadoc(tool)
  • Affected Version: 1.2.0,5.0
  • Priority: P5
  • Status: Closed
  • Resolution: Won't Fix
  • OS: solaris_2.5,windows_xp
  • CPU: x86,sparc
  • Submitted: 1998-04-04
  • Updated: 2024-04-12
  • Resolved: 2017-12-13
Description
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">
Comments
This one suggests there is a need for some JDK-specific taglets that are available when we generate the JDK docs but which are not part of the standard doclet.
12-12-2013
Looking at more generic way to link examples in JDK 9.
12-12-2013
EVALUATION Seems useful, but labor-intensive for J2SE. ###@###.### 2002-12-14 ###@###.### wrote: This is so J2SE-specific, and of much less use to Java developers outside the J2SE developers. ###@###.### wrote March 4, 2005: Perhaps this could be generalized so as to serve our needs without being completely JDK-specific. ###@###.### 2005-05-26 15:40:17 GMT
26-08-2004