API Reference
Parsers
Synopsis.Parsers.Python
Python Parser. See http://www.python.org/dev/peps/pep-0258 for additional info.
- default_docformat
- default documentation format
- primary_file_only
- should only primary file be processed
- sxr_prefix
- Path prefix (directory) to contain sxr info.
- base_path
- Path prefix to strip off of input file names.
Synopsis.Parsers.IDL
None
- cppflags
- list of preprocessor flags such as -I or -D
- primary_file_only
- should only primary file be processed
- base_path
- path prefix to strip off of the file names
- preprocess
- whether or not to preprocess the input
Synopsis.Parsers.Cpp
None
- emulate_compiler
- a compiler to emulate
- language
- source code programming language of the given input file
- compiler_flags
- list of flags for the emulated compiler
- base_path
- path prefix to strip off of the filenames
- primary_file_only
- should only primary file be processed
- cpp_output
- filename for preprocessed file
- flags
- list of preprocessor flags such as -I or -D
Synopsis.Parsers.C
None
- cppflags
- list of preprocessor flags such as -I or -D
- emulate_compiler
- a compiler to emulate
- sxr_prefix
- path prefix (directory) to contain sxr info
- compiler_flags
- list of flags for the emulated compiler
- base_path
- path prefix to strip off of the file names
- primary_file_only
- should only primary file be processed
- preprocess
- whether or not to preprocess the input
Synopsis.Parsers.Cxx
None
- cppflags
- list of preprocessor flags such as -I or -D
- emulate_compiler
- a compiler to emulate
- sxr_prefix
- path prefix (directory) to contain sxr info
- compiler_flags
- list of flags for the emulated compiler
- base_path
- path prefix to strip off of the file names
- primary_file_only
- should only primary file be processed
- preprocess
- whether or not to preprocess the input
Formatters
Synopsis.Formatters.DocBook
Generate a DocBook reference.
- secondary_index_terms
- add fully-qualified names to index
- inline_inherited_members
- show inherited members
- title
- title to be used in top-level section
- nested_modules
- Map the module tree to a tree of docbook sections.
- hide_undocumented
- hide declarations without a doc-string
- graph_color
- base color for inheritance graphs
- generate_summary
- generate scope summaries
- with_inheritance_graphs
- whether inheritance graphs should be generated
- markup_formatters
- Markup-specific formatters.
Synopsis.Formatters.HTML
None
- group_as_section
- Map group to section, instead of keeping it as a single declaration.
- index
- set of index views
- toc_in
- list of table of content files to use for symbol lookup
- title
- title to put into html header
- sxr_prefix
- path prefix (directory) under which to find sxr info
- detail
- set of detail views
- toc_out
- name of file into which to store the TOC
- stylesheet
- stylesheet to be used
- content
- set of content views
- graph_color
- base color for inheritance graphs
- struct_as_class
- Fuse structs and classes into the same section.
- markup_formatters
- Markup-specific formatters.
- directory_layout
- how to lay out the output files
Synopsis.Formatters.BoostBook
The type visitors should generate names relative to the current scope. The generated references however are fully scoped names
Synopsis.Formatters.SXR
This is a facade to the HTML.Formatter. It adds an ‘url’ parameter and dispatches it to various ‘views’.
- sxr_template
- html template to be used by the sxr.cgi script
- title
- title to put into html header
- url
- the base url to use for the sxr cgi
- sxr_prefix
- path prefix (directory) to contain sxr info
- stylesheet
- stylesheet to be used
- src_dir
- starting point for directory listing
- exclude
- TODO: define an exclusion mechanism (glob based ?)
Synopsis.Formatters.List
Generate a high-level list of the content of a syn file. This formatter can lists source files (by name), as well as declarations (by name, type) contained in a given scope.
- show_scope
- list declarations in the given scope
- show_files
- list files
Synopsis.Formatters.Dot
The Formatter class acts merely as a frontend to the various InheritanceGenerators
- hide_operations
- hide operations
- layout
- Direction of graph
- toc_in
- list of table of content files to use for symbol lookup
- format
- Generate output in format “dot”, “ps”, “png”, “svg”, “gif”, “map”, “html”
- hide_attributes
- hide attributes
- base_url
- base url to use for generated links
- show_aggregation
- show aggregation
- bgcolor
- background color for nodes
- prefix
- Prefix to strip from all class names
- title
- the title of the graph
- type
- type of graph (one of “file”, “class”, “single”
Synopsis.Formatters.Dump
None
- show_declarations
- output declarations
- stylesheet
- stylesheet to be referenced for rendering
- show_types
- output types
- show_ids
- output object ids as attributes
- show_files
- output files
Linker and linker scripts
Synopsis.Processors
Visitor that removes duplicate declarations
- remove_empty_modules
- Remove empty modules.
- sxr_prefix
- Compile sxr data, if defined.
- sort_modules
- Sort module content alphabetically.
Synopsis.Processors
A MacroFilter allows macros to be filtered, based on pattern matching. Macros with matching names will be removed.
- pattern
- Regular expression to match macro names with.
Synopsis.Processors
This class processes declarations, and removes those that need greated access than the maximum passed to the constructor
- access
- specify up to which accessibility level the interface should be documented
Synopsis.Processors
A processor that filters modules.
- modules
- List of modules to be filtered out.
- remove_empty
- Whether or not to remove empty modules.
Synopsis.Processors
Abstract base class for name mapping.
Synopsis.Processors
Fold (anonymous) types into enclosing typedefs.
- anonymous_only
- Whether or not folding should be restricted to unnamed types.
Synopsis.Processors
Base class for type mapping
Synopsis.Processors.Comments
A class that detects grouping tags and moves the enclosed nodes into a subnode (a ‘Group’)