Synopsis - Synopsis.Formatters.HTML.Markup.Javadoc.Javadoc

module Synopsis.Formatters.HTML.Markup.Javadoc
class Javadoc
File: ../Synopsis/Formatters/HTML/Markup/Javadoc.py
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
Class attributes Summary:
summary
block_tag
inline_tag
inline_tag_split
xref
tag_name
arg_tags
Methods Summary:
__init__(self)
split(self, doc)
Split a javadoc comment into description and blocks.
extract_summary(self, description)
Generate a summary from the given description.
format(self, decl, view)
Format using javadoc markup.
format_description(self, text, view, decl)
format_inlines(self, view, decl, text)
Formats inline tags in the text.
format_params(self, blocks, view, decl)
format_throws(self, blocks, view, decl)
format_tag(self, tag, blocks, view, decl)
format_inline_tag(self, tag, content, view, decl)
Methods Details:
__init__(self)
Create regex objects for regexps
split(self, doc)
Split a javadoc comment into description and blocks.
extract_summary(self, description)
Generate a summary from the given description.
format(self, decl, view)
Format using javadoc markup.
format_inlines(self, view, decl, text)
Formats inline tags in the text.
format_params(self, blocks, view, decl)
Formats a list of (param, description) tags
Generated on Thu Apr 16 16:27:11 2009 by
synopsis (version devel)