module Synopsis.Formatters.DocBook.Markup.Javadoc
class Javadoc
Javadoc-inheritance
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
Classes Summary:
class Block
references
source code
Class attributes Summary:
source code
source code
source code
source code
source code
source code
source code
Methods Summary:
  __init__(self)
references
source code
  split(self, doc)
references
source code
Split a javadoc comment into description and blocks.
  extract_summary(self, description)
references
source code
Generate a summary from the given description.
  format(self, decl)
references
source code
Format using javadoc markup.
  format_description(self, text, decl)
references
source code
  format_inlines(self, decl, text)
references
source code
Formats inline tags in the text.
  format_params(self, blocks, decl)
references
source code
  format_throws(self, blocks, decl)
references
source code
  format_variablelist(self, tag, blocks, decl)
references
source code
Generate a variablelist for the given tag.
  format_varlistentry(self, tag, blocks, decl)
references
source code
Generate a varlistentry for the given tag.
  format_inline_tag(self, tag, content, decl)
references
source code
Methods Details:
  __init__(self)
references
source code
Create regex objects for regexps
  split(self, doc)
references
source code
Split a javadoc comment into description and blocks.
  extract_summary(self, description)
references
source code
Generate a summary from the given description.
  format(self, decl)
references
source code
Format using javadoc markup.
  format_inlines(self, decl, text)
references
source code
Formats inline tags in the text.
  format_params(self, blocks, decl)
references
source code
Formats a list of (param, description) tags
  format_variablelist(self, tag, blocks, decl)
references
source code
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.
  format_varlistentry(self, tag, blocks, decl)
references
source code
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.