About
Javadoc bundle two concepts:
- the Javadoc syntax
- the Javadoc tool to generate the doc
Articles Related
Syntax
Html Link
/**
*
* @see <a href="http://gerardnico.com">Wiki articles</a>
*/
Author
/**
*
* @author Nicolas GERARD
*/
Link
{@link package.class#member label}
Inserts an in-line link with visible text label that points to the documentation for the specified package, class or member name of a referenced class.
As a method is a member:
{@link #myMethod label}
inheritDoc
/**
* {@inheritDoc}
*/
List
in a HTML - UL element (unordered list)
<ul>
<li>UTF-8 - {@link ByteOrderMark#UTF_8}</li>
<li>UTF-16BE - {@link ByteOrderMark#UTF_16LE}</li>
<li>UTF-16LE - {@link ByteOrderMark#UTF_16BE}</li>
<li>UTF-32BE - {@link ByteOrderMark#UTF_32LE}</li>
<li>UTF-32LE - {@link ByteOrderMark#UTF_32BE}</li>
</ul>
Code
<pre>
BOMInputStream bomIn = new BOMInputStream(in);
if (bomIn.hasBOM()) {
// has a UTF-8 BOM
}
</pre>
Version
@version $Id$
Since
@since 2.0