idl2html 2.41

idl2html is a Perl module that enerates HTML documentation from IDL source files.

SYNOPSIS

idl2html [options] spec.idl

OPTIONS

All options are forwarded to C preprocessor, except -f -h -i -o -s -t -v -x.

With the GNU C Compatible Compiler Processor, useful options are :

-D name
-D name=definition
-I directory
-I-
-nostdinc

Specific options :

-f

Enable the frameset mode.

-h

Display help.

-i directory

Specify a path for import (only for version 3.0).

-o file

Specificy the outfile for HTML Help (default "htmlhelp").

-s style

Generate an external Cascading Style Sheet file.

-t title

Specificy the title of HTML Help.

-v

Display version.

-x

Enable export (only for version 3.0).

idl2html parses the declarations and doc comments in a IDL source file and formats these into a set of HTML pages. idl2html generates some helper files for HTML Help compiler.

idl2html works like javadoc.

Within doc comments, idl2html supports the use of special doc tags to augment the documentation. idl2html also supports standard HTML within doc comments. This is useful for formatting text.

idl2html reformats and displays declaration for:

Modules, interfaces and value types

Operations (with parameters) and attributes

Types (typedef, enum, struct, union with members)

Exceptions (with members)

Constants

Pragma (ID, version as tag)