Config for the main linker module. The linker performs various options on an AST, including some which are essential when merging multiple AST's.
| verbose | Boolean value indicating whether to print extra information on what's going on. Can be useful for debugging problems |
| strip | A list of strings, where each string is a scoped name to strip from the front of declarations. If this list is not empty, any declaration not matching one of the strip names will be removed from the AST. The default is [], but an example is ['boost::python']. |
| mapper_list | A list of mappers (?) |
| max_access | Maximum access level to permit - any declaration with a lower accessibility (higher access level) will be removed. The default is None, which disables the operation. Possible values are 1 for public (only public members shown), 2 for protected (only public and protected shown) |
| map_declaration_names | Prepends some namespace onto each name in the AST. This is used for example by the Synopsis RefManual to place all C++ code in the Synopsis.Parser.C++ package. The value should be a tuple of two strings - the namespace separated by ::'s and the type of module to use (eg: Module or Package). The default value is None. |
| map_declaration_type | The type (string) of the declarations inserted when mapping declarations. |
| operations | The list of operations to perform on the AST. The default is ['Unduplicator', 'Stripper', 'NameMapper', 'Comments', 'EmptyNS', 'AccessRestrictor']. Others include 'LanguageMapper' and 'XRefCompiler'. |
| comment_processors | a list of processors to use which use declaration comments to perform actions. The default is an empty list, but an example minimum you would use is ['ssd', 'summary']. The processors are: (note that any you do use should be in this order!): ssd: removes any comment not in the "//." style and removes the prefix. ss: removes any comment not in the "//" style and removes the prefix. java: removes any comment not in Java's "/** */" style and removes the prefix. dummy: removes dummy declarations from the C++ parser. prev: extends dummy to move comments that belong to the previous declaration (comments that begin with "<") summary: extracts a summary from comments, needed for normal documentation. javatags: extracts JavaDoc-style tags from comments, needed to display things like @param and @return properly. |
| Classes Summary: | |
| XRefCompiler This is the config object for the XRefCompiler module. [Source] | |
| Operations Summary: | |
| __init__(self, argv) [Source] | |