NAME
idl2html - Generates HTML documentation from IDL source files.
SYNOPSYS
idl2html [options] spec.idl
OPTIONS
All options are forwarded to C preprocessor.
With the GNU C Compatible Compiler Processor, useful options are :
DESCRIPTION
idl2html parses the declarations and doc comments in a IDL source file and formats these into a set of HTML pages.
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 and attributes
- Types (typedef, enum, struct, union)
- Exceptions
- Constants
Doc Comments
IDL source files can include doc comments. Doc comments begin with /** and indicate text to be included automatically in generated documentation.
Doc comments immediately preceed the entity being documented.
Standard HTML
You can embed standard HTML tags within a doc comment. However, don't use tags heading tags like <H1> or <HR>. idl2html creates an entire structured document and these structural tags interfere with formatting of the generated document.
idl2html Tags (not yet implemented)
idl2html parses special tags that are recognized when they are embedded within an IDL doc comment. These doc tags enable you to autogenerate a complete, well-formatted document from your source code. The tags start with an @.
Tags must start at the beginning of a line.
SPECIAL REQUIREMENTS
idl2html needs Math::BigInt and CORBA::Fixed modules.
idl2html needs a cpp executable or CL.EXE for Microsoft Windows.
CORBA Specifications, including IDL (Interface Definition Language) are available on <http://www.omg.org/>.
SEE ALSO
cpp, javadoc, perl
AUTHOR
Francois PERRAD <perrad@besancon.sema.slb.com>