Package epydoc :: Package markup :: Module javadoc
[hide private]
[frames] | no frames]

Module javadoc

source code

Epydoc parser for Javadoc docstrings. Javadoc is an HTML-based markup language that was developed for documenting Java APIs with inline comments. It consists of raw HTML, augmented by Javadoc tags. There are two types of Javadoc tag: Epydoc supports all Javadoc tags, except:


Warning: Epydoc only supports HTML output for Javadoc docstrings.

Classes [hide private]
  ParsedJavadocDocstring
An encoded version of a Javadoc docstring.
Functions [hide private]
ParsedDocstring
parse_docstring(docstring, errors, **options)
Parse the given docstring, which is formatted using Javadoc; and return a ParsedDocstring representation of its contents.
source code
Function Details [hide private]

parse_docstring(docstring, errors, **options)

source code 
Parse the given docstring, which is formatted using Javadoc; and return a ParsedDocstring representation of its contents.
Parameters:
  • docstring (string) - The docstring to parse
  • errors (list of ParseError) - A list where any errors generated during parsing will be stored.
  • options - Extra options. Unknown options are ignored. Currently, no extra options are defined.
Returns: ParsedDocstring