Java Solaris Communities Sun Store Join SDN My Profile Why Join?
 
Bug Database
Bug Detail
Quick Lists
Top 25 Bugs
Top 25 RFE's
Recently Closed Bugs
Printable Page Printable Page


Bug Database
Bug ID: 4125834
Votes 4
Synopsis Add @tutorial tag for linking to the Java Tutorial
Category doclet:tbd
Reported Against 1.2beta3 , tiger-beta2
Release Fixed
State 6-Fix Understood, request for enhancement
Priority: 5-Very Low
Related Bugs
Submit Date 04-APR-1998
Description
Developers need access to examples from javadoc pages.
The way  xxxxx  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  xxxxx  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">
Work Around
N/A
Evaluation
Seems useful, but labor-intensive for J2SE.
 xxxxx@xxxxx  2002-12-14

 xxxxx@xxxxx  wrote:
 This is so J2SE-specific, and of much less use to Java developers outside the 
 J2SE developers.

 xxxxx@xxxxx  wrote March 4, 2005:
 Perhaps this could be generalized so as to serve our needs without
 being completely JDK-specific.
 xxxxx@xxxxx  2005-05-26 15:40:17 GMT
Comments
  
  Include a link with my name & email   

Submitted On 14-SEP-1998
seloi
thanks a lot 


Submitted On 25-AUG-2004
benjamin.podoll
The LayoutManagers don't have any links to their associated tutorials (and those links are needed for all layout manager classes)



PLEASE NOTE: JDK6 is formerly known as Project Mustang