JDK-4034233 : Add @xref doc-comment tag (similar to @link)
  • Type: Enhancement
  • Component: tools
  • Sub-Component: javadoc(tool)
  • Affected Version: 1.1
  • Priority: P5
  • Status: Closed
  • Resolution: Duplicate
  • OS: solaris_2.5.1
  • CPU: generic
  • Submitted: 1997-02-24
  • Updated: 2014-05-05
  • Resolved: 1998-04-04
Related Reports
Duplicate :  
Relates :  
Relates :  
Description
Especially when javadoc is once again used to generate hardcopy documentation (such as -doctype MIF), it would be useful to add a doc-comment tag that translates into the appropriate target code a cross reference.  The syntax would look something like:

	@xref(text, reference)

For example:

	/**
	 * An instance of a @xref(scroll bar, ScrollBar) is ...
	 */

would generate FramkeMaker output such as:

	An instance of a scroll bar (S5.3.2) is ...

and would generate HTML output such as:

	An instance of a <a href="ScrollBar">scroll bar</a> is ...

Note that "(..., ...)" is a new syntax for doc-comment tags.  Consequently, care must be taken to ensure that the simplest, but most extensible format is chosen.




Comments
PUBLIC COMMENTS
10-06-2004

EVALUATION A cross-reference is really just a link. Maybe there should be no differentiation. In that case, this is a dupe of 4079986 doug.kramer@Eng 1997-10-07 Yes, this is a dupe of 4079986 and 4097252
07-10-1997