JDK-4034242 : Add @footnote and @footnoteref doc-comment tags
  • Type: Enhancement
  • Component: tools
  • Sub-Component: javadoc(tool)
  • Affected Version: 1.1
  • Priority: P5
  • Status: Resolved
  • Resolution: Won't Fix
  • OS: solaris_2.5.1
  • CPU: generic
  • Submitted: 1997-02-24
  • Updated: 2014-05-05
  • Resolved: 2013-12-12
Related Reports
Relates :  
Description
Especially when javadoc is once again used to generate hardcopy documentation (such as -doctype MIF), it would be useful to add doc-comment tags that translate into the appropriate target code footnotes and references to footnotes.  The syntax would look something like:

	{@footref identifier}         In-line tag
	@footnote identifier text     Standalone tag

Use the in-line tag in the body of the text, and the standalone tag
later in the normal tag section of the doc comment.  The "identifier"
connects "footref" to "footnote".

For example:

	/**
	 * An instance of a scroll bar{@footref scrollbar} is ...
	 * ...
	 * @footnote scrollbar A scroll bar is a visual control.
	 */

would generate FramkeMaker output such as (where the "1" is superscripted):

	An instance of a scroll bar1 is ...               (text)
	...
	1 A scroll bar is a visual control.               (footnote)

and would generate HTML output such as:

	An instance of a <a href="scrollbar">scroll bar</a> is ...
	...
	<a name="scrollbar"><sup>1</sup></a> A scroll bar is a visual control.




Comments
We do not support the MIF-doclet anymore.
12-12-2013

WORK AROUND
11-06-2004

SUGGESTED FIX
11-06-2004

PUBLIC COMMENTS
10-06-2004

EVALUATION This is something we might want to eventually add, but not for 1.2 doug.kramer@Eng 1998-04-03
03-04-1998