A formatter that formats comments similar to Javadoc @tags
| Operations Summary: | |
| __init__(self) Create regex objects for regexps [Source] | |
| extract(self, regexp, str) Extracts all matches of the regexp from the text. [Source] | |
| format(self, page, decl, text) Format any @tags in the text, and any @tags stored by the JavaTags CommentProcessor in the Linker stage. [Source] | |
| format_inline_see(self, page, decl, text) Formats inline @see tags in the text [Source] | |
| format_params(self, param_tags) Formats a list of (param, description) tags [Source] | |
| format_attrs(self, attr_tags) Formats a list of (attr, description) tags [Source] | |
| format_return(self, return_tag) Formats a since description string [Source] | |
| format_see(self, page, see_tags, decl) Formats a list of (ref,description) tags [Source] | |
| find_link(self, page, ref, decl) Given a "reference" and a declaration, returns a HTML link. [Source] | |
| _find_link_at(self, ref, scope) [Source] | |
| _find_method_entry(self, name, scope) Tries to find a TOC entry for a method adjacent to decl. [Source] | |
| Operations Inherited from CommentFormatterStrategy | |
| format_summary | |
| Operation Details: |
Extracts all matches of the regexp from the text. The MatchObjects are returned in a list
Given a "reference" and a declaration, returns a HTML link. Various methods are tried to resolve the reference. First the parameters are taken off, then we try to split the ref using '.' or '::'. The params are added back, and then we try to match this scoped name against the current scope. If that fails, then we recursively try enclosing scopes.
Tries to find a TOC entry for a method adjacent to decl. The enclosing scope is found using the types dictionary, and the realname()'s of all the functions compared to ref.