Developers need access to examples from javadoc pages.
The way JavaSoft provides examples is via the Java Tutorial.
Therefore we should formalize a way to link to the tutorial.
A standalone tag should be sufficient.
Suggest adding @tutorial tag:
SYNTAX: @tutorial relativepath text
EXAMPLE: @tutorial i18n/index.html Internationalization Tutorial
where "relativepath" is the known path to the tutorial from
some root to be specified on the javadoc command line.
This link would point either to the JavaSoft website or to
a local drive, depending on the root:
1) javadoc -tutorialpath "http://java.sun.com/docs/books/tutorial"
would generate:
<a href="http://java.sun.com/docs/books/tutorial/i18n/index.html">
2) javadoc -tutorialpath "../tutorial"
would generate:
<a href="../tutorial/i18n/index.html">
The way JavaSoft provides examples is via the Java Tutorial.
Therefore we should formalize a way to link to the tutorial.
A standalone tag should be sufficient.
Suggest adding @tutorial tag:
SYNTAX: @tutorial relativepath text
EXAMPLE: @tutorial i18n/index.html Internationalization Tutorial
where "relativepath" is the known path to the tutorial from
some root to be specified on the javadoc command line.
This link would point either to the JavaSoft website or to
a local drive, depending on the root:
1) javadoc -tutorialpath "http://java.sun.com/docs/books/tutorial"
would generate:
<a href="http://java.sun.com/docs/books/tutorial/i18n/index.html">
2) javadoc -tutorialpath "../tutorial"
would generate:
<a href="../tutorial/i18n/index.html">