Synopsis - Synopsis.Formatters.HTML.Markup.Markup.Formatter

package Synopsis.Formatters.HTML.Markup.Markup
class Formatter
File: ../Synopsis/Formatters/HTML/Markup/__init__.py
Interface class that takes a 'doc' annotation and formats its text. Markup-specific subclasses should provide appropriate format methods.
Protected Methods Summary:
_lookup_symbol_in(self, symbol, scope)
_find_method_entry(self, name, scope)
Methods Summary:
init(self, processor)
format(self, decl, view)
Format the declaration's documentation.
lookup_symbol(self, symbol, scope)
Given a symbol and a scope, returns an URL.
Methods Details:
format(self, decl, view)
Format the declaration's documentation. @param view the View to use for references and determining the correct relative filename. @param decl the declaration @returns Struct containing summary / details pair.
lookup_symbol(self, symbol, scope)
Given a symbol and a scope, returns an URL. Various methods are tried to resolve the symbol. First the parameters are taken off, then we try to split the symbol 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.
Generated on Thu Apr 16 16:27:11 2009 by
synopsis (version devel)