Name: tb29552 Date: 09/18/97


Allow a '@link <something>' syntax anywhere within
a javadoc comment, which would be expanded to an
HTML link in a similar manner to a '@see' link.

The <something> would be compatible with the
'@see' link syntax.

In order to keep the text displayed for such links
reasonably short, allow the possibility of
surrounding in '{}' the part of the specification
which will appear in the visible HTML text; for
example, '@link capella.queryTree.{Tokenizer.readToken}(int)'
would be displayed as 'Tokenizer.readToken' in the
HTML text. If no '{}' are specified, the default
text would be the whole link specification, which
is compatible with the current semantics.

By allowing to keep the text generated for the
link reasonably short, such links would not
interrupt the flow of the text. See also my
previous feature request, which would help to
shorten most link specifications in the javadoc
comment itself, by allowing the shortcuts
available within the java source ('super' and
'import').

The ability to easily add links within the
comments would encourage programmers to do so,
resulting in better javadoc documents.
company - Capella Computers Ltd. , email - ###@###.###
======================================================================