Duplicate :
|
|
Relates :
|
|
Relates :
|
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.
|