Home | Trees | Indices | Help |
|
---|
|
@tag [arg]
", where tag
indicates the type of block, and arg
is an optional argument. (For fields
that take arguments, Javadoc assumes that the single word immediately
following the tag is an argument; multi-word arguments cannot be used
with javadoc.)
{@tag [args...]}
", where tag
indicates the type of inline markup, and
args
are optional arguments.
{@docRoot}
, which gives the (relative) URL of the
generated documentation's root.
{@inheritDoc}
, which copies the documentation of the
nearest overridden object. This can be used to combine the
documentation of the overridden object with the documentation of the
overridding object.
@serial
, @serialField
, and
@serialData
which describe the serialization (pickling)
of an object.
{@value}
, which copies the value of a constant.
Warning: Epydoc only supports HTML output for Javadoc docstrings.
|
|||
ParsedJavadocDocstring An encoded version of a Javadoc docstring. |
|
|||
ParsedDocstring |
|
|
ParsedDocstring representation of its contents.
|
Home | Trees | Indices | Help |
|
---|
Generated by Epydoc 3.0beta1 on Thu Mar 1 04:23:22 2007 | http://epydoc.sourceforge.net |