The DocBook Formatter
Prev | Chapter 4. Processor Design | Next

## The DocBook Formatter

The DocBook formatter allows to generate a DocBook section from the given ASG.

Here are the most important parameters:

title

  The title to be used for the toplevel section.

nested_modules

  True if nested modules are to be formatted to nested sections. If False, modules are flattened and formatted in sibling sections.

generate_summary

  If True, generate a summary section for each scope, followed by a details section.

with_inheritance_graph

  If True, generate `SVG` and `PNG` inheritance graphs for all classes. (use the `graph_color` option to set the background color of the graph nodes)

secondary_index_terms

  If True, add `secondary` entries in `indexterms`, with the fully qualified names. This is useful for disambiguation when the same unqualified-id is used in multiple scopes.

Prev | Up | Next
The Dump Formatter | Home | The Dot Formatter