Class: Formatter

Extending classes:

FormatterHTB, FormatterLaTeX

Base class of formatters. Specializations of this class act like an output file that writes standard text as well as some additional formatting directives. The different formatters differ in the way they quote special characters in standard text passages and in the way they use and write formatting directives.

This standard formatter currently does not provide any output. This implementation might be extended in the future to implement a man function similar to the help function but with evaluation of formatting directives.

Member of class Formatter

• m_dest = None

• Method: Formatter.close
• Method: Formatter.closeContext
• Method: Formatter.headline1
• Method: Formatter.headline2
• Method: Formatter.headline3
• Method: Formatter.write
• Method: Formatter.write_class_header
• Method: Formatter.write_class_synopsis
• Method: Formatter.write_codelinebreak
• Method: Formatter.write_codelineinsertion
• Method: Formatter.write_fn_synopsis
• Method: Formatter.write_function_header
• Method: Formatter.write_header_fn_section
• Method: Formatter.write_index
• Method: Formatter.write_item
• Method: Formatter.write_label
• Method: Formatter.write_linebreak
• Method: Formatter.write_mode
• Method: Formatter.write_multi_module_header
• Method: Formatter.write_ref
• Method: Formatter.write_refToContext
• Method: Formatter.write_single_module_header
• Method: Formatter.write_undocumented
• Method: Formatter.write_vars