A formatter that formats comments similar to Javadoc.
See `Javadoc Spec`_ for info.
.. _Javadoc Spec: http://java.sun.com/j2se/1.5.0/docs/tooldocs/solaris/javadoc.html
Methods Details:
Create regex objects for regexps
Split a javadoc comment into description and blocks.
(self, description)
Generate a summary from the given description.
Format using javadoc markup.
Formats inline tags in the text.
Formats a list of (param, description) tags
Generate a variablelist for the given tag.
Each matching block is formatted to a varlistentry, with the value
of its 'arg' member becoming the term.
Generate a varlistentry for the given tag.
The tag value itself becomes the term. If multiple blocks match,
format them as an (inlined) simplelist, otherwise as a para.