Synopsis - Synopsis.Formatters.HTML.Fragments.DeclarationFormatter.DeclarationFormatter

module Synopsis.Formatters.HTML.Fragments.DeclarationFormatter
class DeclarationFormatter
File: ../Synopsis/Formatters/HTML/Fragments/DeclarationFormatter.py
Base class for SummaryFormatter and DetailFormatter. The two classes SummaryFormatter and DetailFormatter are actually very similar in operation, and so most of their methods are defined here. Both of them print out the definition of the declarations, including type, parameters, etc. Some things such as exception specifications are only printed out in the detailed version.
Methods Summary:
register(self, formatter)
format_parameters(self, parameters)
Returns formatted string for the given parameter list.
format_declaration(self, decl)
The default is to return no type and just the declarations name for the name.
format_macro(self, decl)
format_forward(self, decl)
format_group(self, decl)
format_scope(self, decl)
Scopes have their own views, so return a reference to it.
format_module(self, decl)
format_meta_module(self, decl)
format_class(self, decl)
format_class_template(self, decl)
format_typedef(self, decl)
format_enumerator(self, decl)
format_enum(self, decl)
format_variable(self, decl)
format_const(self, decl)
format_function(self, decl)
format_function_template(self, decl)
format_operation(self, decl)
format_operation_template(self, decl)
format_parameter(self, parameter)
Methods Details:
format_parameters(self, parameters)
Returns formatted string for the given parameter list.
format_declaration(self, decl)
The default is to return no type and just the declarations name for the name.
format_scope(self, decl)
Scopes have their own views, so return a reference to it.
format_typedef(self, decl)
(typedef type, typedef name)
format_enumerator(self, decl)
This is only called by formatEnum
format_enum(self, decl)
(enum name, list of enumerator names)
format_const(self, decl)
(const type, const name = const value)
format_function(self, decl)
(return type, func + params + exceptions)
format_function_template(self, decl)
(return type, func + params + exceptions)
format_parameter(self, parameter)
Returns one string for the given parameter
Generated on Thu Apr 16 16:27:09 2009 by
synopsis (version devel)