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.

Data Structure Documentation

◆ CleDoc

struct CleDoc

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.

Definition at line 107 of file CLEDEF.h.

Data Fields
const char *	pcAnc	Optional anchor for this chapter (printed in front of headline in double square brackets).
const char *	pcHdl	Headline for this chapter.
const char *	pcIdt	Optional new line separated list of index term for this chapter (printed at the end (indexterm:[])).
const char *	pcKyw	Optional ASCIIDOC key word (printed in front of headline in single square brackets).
const char *	pcMan	Optional or required manual page with the content of this chapter).
const char *	pcNum	String for numbering or NULL for no number prefix.
unsigned int	uiLev	The level of the chapter in the document (cover page is 1 all other chapter > 1).
unsigned int	uiTyp	One of the documentation types above.

Macro Definition Documentation

◆ CLEDOC_CLS

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

Ends a table with constant definitions.

Definition at line 142 of file CLEDEF.h.

◆ CLEDOC_OPN

#define CLEDOC_OPN ( name ) TsCleDoc name[]

Starts the documentation generation table overview.

Parameters

name	Name of this table.

Definition at line 123 of file CLEDEF.h.

◆ 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.

Definition at line 137 of file CLEDEF.h.

Typedef Documentation

◆ TsCleDoc

typedef struct CleDoc TsCleDoc