Synopsis - Synopsis.Formatters.BoostBook.Formatter

module Synopsis.Formatters.BoostBook
class Formatter
File: ../Synopsis/Formatters/BoostBook.py
The type visitors should generate names relative to the current scope. The generated references however are fully scoped names
Methods Summary:
process(self, ir, * * kwds)
scope(self)
push_scope(self, newscope)
pop_scope(self)
write(self, text)
Write some text to the output stream, replacing 's with 's and indents.
start_entity(self, __type, * * __params)
end_entity(self, type)
write_entity(self, __type, __body, * * __params)
entity(self, __type, __body, * * __params)
reference(self, ref, label)
label(self, ref)
type_label(self)
visit_builtin_type_id(self, type)
visit_unknown_type_id(self, type)
visit_declared_type_id(self, type)
visit_modifier_type_id(self, type)
visit_parametrized_type_id(self, type)
format_type(self, type)
visit_function_type_id(self, type)
process_doc(self, doc)
visit_declarator(self, node)
visit_typedef(self, typedef)
visit_variable(self, variable)
visit_const(self, const)
visit_module(self, module)
visit_class(self, class_)
visit_inheritance(self, inheritance)
visit_parameter(self, parameter)
visit_function(self, function)
visit_operation(self, operation)
do_function(self, func)
visit_enumerator(self, enumerator)
visit_enum(self, enum)
Methods Details:
write(self, text)
Write some text to the output stream, replacing 's with 's and indents.
start_entity(self, __type, * * __params)
Write the start of an entity, ending with a newline
end_entity(self, type)
Write the end of an entity, starting with a newline
write_entity(self, __type, __body, * * __params)
Write a single entity on one line (though body may contain newlines)
entity(self, __type, __body, * * __params)
Return but do not write the text for an entity on one line
reference(self, ref, label)
reference takes two strings, a reference (used to look up the symbol and generated the reference), and the label (used to actually write it)
do_function(self, func)
Stuff common to functions and methods, contructors, destructors
Generated on Thu Apr 16 16:26:56 2009 by
synopsis (version devel)