CLE Docu Table

The structure and corresponding macros are used to define a table in order to generate documentation. More...

Data Structures
struct	CleDoc
	CLE Structure for documentation table. More...

Macros
#define	CLEDOC_OPN(name)   TsCleDoc name[]
	Starts the documentation generation table overview. More...
#define	CLETAB_DOC(typ, lev, num, kyw, anc, hdl, man, idt)   {(typ),(lev),(num),(kyw),(anc),(hdl),(man),(idt)},
	Starts the documentation generation table. More...
#define	CLEDOC_CLS   { 0 , 0 , NULL, NULL, NULL, NULL, NULL, NULL}
	Ends a table with constant definitions. More...

Typedefs
typedef struct CleDoc	TsCleDoc
	CLE Structure for documentation table. More...

Detailed Description

The structure and corresponding macros are used to define a table in order to generate documentation.

Macro Definition Documentation

CLEDOC_OPN

#define CLEDOC_OPN

(

name

)

TsCleDoc name[]

Starts the documentation generation table overview.

Parameters

name	Name of this table.

CLETAB_DOC

#define CLETAB_DOC	(		typ,
			lev,
			num,
			kyw,
			anc,
			hdl,
			man,
			idt
	)		{(typ),(lev),(num),(kyw),(anc),(hdl),(man),(idt)},

Starts the documentation generation table.

Parameters

[in]	typ	Documentation type.
[in]	lev	Level of the chapter.
[in]	num	Prefix for number string.
[in]	kyw	Optional ASCIIDOC key word (printed in front of headline in single square brackets).
[in]	anc	Optional anchor for this chapter (printed in front of headline in double square brackets).
[in]	hdl	Headline for this chapter.
[in]	man	Optional manual page for this chapter.
[in]	idt	Optional new line separated list of index terms for this chapter.

CLEDOC_CLS

#define CLEDOC_CLS   { 0 , 0 , NULL, NULL, NULL, NULL, NULL, NULL}

Ends a table with constant definitions.

Typedef Documentation

TsCleDoc

typedef struct CleDoc TsCleDoc

CLE Structure for documentation table.

This structure is used to build a table with the macros CLEDOC_OPN, CLETAB_DOC and CLEDOC_CLS. This table must be provided to the function siCleExecute for documentation generation using the built-in functions GENDOCU and HTMLDOC.