| Home | Trees | Index | Help |  | 
|---|
| Package epydoc :: Package markup :: Module javadoc | 
 | 
@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.)
  {@ }", 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.
| Classes | |
|---|---|
| ParsedJavadocDocstring | An encoded version of a Javadoc docstring. | 
| Function Summary | |
|---|---|
| ParsedDocstring | Parse the given docstring, which is formatted using Javadoc; and return a ParsedDocstringrepresentation of its contents. | 
| Function Details | 
|---|
| parse_docstring(docstring, errors, **options)Parse the given docstring, which is formatted using Javadoc; and return aParsedDocstringrepresentation of its 
  contents.
 | 
| Home | Trees | Index | Help |  | 
|---|
| Generated by Epydoc 2.1 on Sat Mar 20 17:46:14 2004 | http://epydoc.sf.net |