module Synopsis.Formatters.BoostBook
class Formatter
Formatter-inheritance
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)
references
source code
  scope(self)
references
source code
  push_scope(self, newscope)
references
source code
  pop_scope(self)
references
source code
  write(self, text)
references
source code
Write some text to the output stream, replacing 's with 's and indents.
  start_entity(self, __type, * * __params)
references
source code
  end_entity(self, type)
references
source code
  write_entity(self, __type, __body, * * __params)
references
source code
  entity(self, __type, __body, * * __params)
references
source code
  reference(self, ref, label)
references
source code
  label(self, ref)
references
source code
  type_label(self)
references
source code
  visit_builtin_type_id(self, type)
references
source code
  visit_unknown_type_id(self, type)
references
source code
  visit_declared_type_id(self, type)
references
source code
  visit_modifier_type_id(self, type)
references
source code
references
source code
  format_type(self, type)
references
source code
  visit_function_type_id(self, type)
references
source code
  process_doc(self, doc)
references
source code
  visit_declarator(self, node)
references
source code
  visit_typedef(self, typedef)
references
source code
  visit_variable(self, variable)
references
source code
  visit_const(self, const)
references
source code
  visit_module(self, module)
references
source code
  visit_class(self, class_)
references
source code
  visit_inheritance(self, inheritance)
references
source code
  visit_parameter(self, parameter)
references
source code
  visit_function(self, function)
references
source code
  visit_operation(self, operation)
references
source code
  do_function(self, func)
references
source code
  visit_enumerator(self, enumerator)
references
source code
  visit_enum(self, enum)
references
source code
Methods Details:
  write(self, text)
references
source code
Write some text to the output stream, replacing 's with 's and indents.
  start_entity(self, __type, * * __params)
references
source code
Write the start of an entity, ending with a newline
  end_entity(self, type)
references
source code
Write the end of an entity, starting with a newline
  write_entity(self, __type, __body, * * __params)
references
source code
Write a single entity on one line (though body may contain newlines)
  entity(self, __type, __body, * * __params)
references
source code
Return but do not write the text for an entity on one line
  reference(self, ref, label)
references
source code
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)
references
source code
Stuff common to functions and methods, contructors, destructors