CLE Structure for documentation table. More...

#include <CLEDEF.h>

Data Fields
unsigned int	uiTyp
	One of the documentation types above. More...

unsigned int	uiLev
	The level of the chapter in the document (cover page is 1 all other chapter > 1). More...

const char *	pcNum
	String for numbering or NULL for no number prefix. More...

const char *	pcKyw
	Optional ASCIIDOC key word (printed in front of headline in single square brackets). More...

const char *	pcAnc
	Optional anchor for this chapter (printed in front of headline in double square brackets). More...

const char *	pcHdl
	Headline for this chapter. More...

const char *	pcMan
	Optional or required manual page with the content of this chapter). More...

const char *	pcIdt
	Optional new line separated list of index term for this chapter (printed at the end (indexterm:[])). More...

Detailed Description

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.

Field Documentation

◆ uiTyp

unsigned int CleDoc::uiTyp

One of the documentation types above.

◆ uiLev

unsigned int CleDoc::uiLev

The level of the chapter in the document (cover page is 1 all other chapter > 1).

◆ pcNum

const char* CleDoc::pcNum

String for numbering or NULL for no number prefix.

◆ pcKyw

const char* CleDoc::pcKyw

Optional ASCIIDOC key word (printed in front of headline in single square brackets).

◆ pcAnc

const char* CleDoc::pcAnc

Optional anchor for this chapter (printed in front of headline in double square brackets).

◆ pcHdl

const char* CleDoc::pcHdl

Headline for this chapter.

◆ pcMan

const char* CleDoc::pcMan

Optional or required manual page with the content of this chapter).

◆ pcIdt

const char* CleDoc::pcIdt

Optional new line separated list of index term for this chapter (printed at the end (indexterm:[])).

The documentation for this struct was generated from the following file:

CLEDEF.h

Data Fields