Synopsis 0.5 - User Manual

CORBA IDL Parser

The CORBA IDL Parser uses OmniORB's (Python) IDL compiler library to parse IDL files and generate an AST. You will need to have the omniidl package installed to use this parser. There is no support for SXR or XREF features.

name (string)

Name of this config object: Must be 'IDL'

verbose (boolean)

Verbosity flag. For config files, this attribute is set by the constructor, but only if 'verbose' was passed as a config option.

Can be set to true from the command line with "-Wp,-v"

main_file (boolean)

Flag that selects if should only store the AST generated from the file(s) being processed, and not included files. The default is 1 (true).

Can be set to true from the command line with "-Wp,-m"

basename (string)

A file path to strip from the start of all filenames before storing. Setting this option for example will remove any redundant parent directories in the HTML FileListing page.

Can be set from the command line with, e.g.: "-Wp,-b,../some/basename/"

include_path (list of strings)

A list of paths to add to the include path. For example: ['/usr/local/corba/', '../idl']

Can be set from the command line with, e.g.: "-Wp,-I,/usr/local/corba/,-I,../idl"

keep_comments (boolean)

If true, comments will be stored in the AST. The default is true.

Can be set to true from the command line with "-Wp,-K" (note upper case K)

Can be set to false from the command line with "-Wp,-k"