JDK-4034267 : javadoc template: Add automatic link capability within descriptions
  • Type: Enhancement
  • Component: tools
  • Sub-Component: javadoc(tool)
  • Affected Version: 1.1,1.1.3
  • Priority: P5
  • Status: Closed
  • Resolution: Duplicate
  • OS: solaris_2.5.1,windows_95
  • CPU: generic,x86
  • Submitted: 1997-02-25
  • Updated: 2014-05-05
  • Resolved: 1998-04-01
Related Reports
Duplicate :  
Duplicate :  
Relates :  
Description
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".

Comments
EVALUATION This is very similar to the request 4079986. This should be done in the template with post-processing of text. The author of RFE 4079986 wants a more definitive solution. This one is open to ambiguity -- two constructors named Date(int) and Date(String) could be confused. doug.kramer@Eng 1997-10-07 Duplicate of 4097252. Will be solved by adding inline links. doug.kramer@Eng 1998-03-31
07-10-1997