Help on IDLdoc output

Routine summary

The routine summary simply provides the calling sequence for each routine in the file and the first sentence of the detailed description.

Routine Details

The routine details sections gives a possibly longer description of the routine as well as a tables of the parameters and keywords accepted by the routine. All the parameters and keywords of the routine will be in these tables regardless if they have been commented using IDLdoc.

Notes on routine attributes

See the IDLdoc page for IDLdoc itself for a full listing of the attributes of a routine.

Attribute Description

abstract The routine name will be italicized if the routine is marked "abstract" (meaning it is not implemented, it is provided for its interface). This is generally used in only object-oriented programming.

private This routine is not intended to be called except by other routines in the same file. In other words it is a "helper routine".

Keyword and parameter attributes

Attribute	Description
in	indicates that the argument is intended to be passed into the routine.
out	indicates that the argument is intended to be used to pass a value out of the routine. A named variable must be passed to the routine to pass a value back to the calling level.
optional	indicates the argument is optional; optional parameters and keywords are also placed inside brackets ([]) in the routine summary.
required	indicates the argument is required
type	"type" indicates the type of the variable. Can be used indicate a group of types, a specific type, an array of a certain type, etc. Boolean keywords are indicated by a /KEYWORD_NAME in the routine summary.

Produced by IDLdoc 1.6 on Thu Jun 2 23:56:40 2005

Attribute	Description
abstract	The routine name will be italicized if the routine is marked "abstract" (meaning it is not implemented, it is provided for its interface). This is generally used in only object-oriented programming.
private	This routine is not intended to be called except by other routines in the same file. In other words it is a "helper routine".