-
Enhancement
-
Resolution: Duplicate
-
P5
-
None
-
1.1, 1.1.3
-
generic, x86
-
solaris_2.5.1, windows_95
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".
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".
- duplicates
-
JDK-4079986 javadoc: @link - Allow embedded links in javadoc comments.
- Closed
-
JDK-4097252 Add syntax to generate in-line @see links in descriptions and tag text
- Closed
- relates to
-
JDK-4034233 Add @xref doc-comment tag (similar to @link)
- Closed