CLE Other CLP string table

Structure and corresponding macros containing CLP string table in order to append to generated documentation. More...

Data Structures
struct	CleOtherClp
	CLE table structure for other CLP strings. More...

Macros
#define	CLEOTH_OPN(name)   TsCleOtherClp name[]
	Starts a table with other CLP strings. More...
#define	CLETAB_OTH(rot, kyw, tab, man, hlp, ovl)   {(rot),(kyw),(tab),(man),(hlp),(ovl)},
	Defines a appendix for the object or overlay cmd of the root rot with the headline of hdl for a certain other CLP string. . More...
#define	CLEOTH_CLS   { NULL, NULL, NULL, NULL, NULL, 0}
	Ends a table with other CLP strings. More...

Typedefs
typedef struct CleOtherClp	TsCleOtherClp
	CLE table structure for other CLP strings. More...

Detailed Description

Structure and corresponding macros containing CLP string table in order to append to generated documentation.

---

Data Structure Documentation

CleOtherClp

struct CleOtherClp

CLE table structure for other CLP strings.

This structure is used to define a table of CLP strings in order to add as appendix to the generated documentation.

Definition at line 448 of file CLEDEF.h.

Collaboration diagram for CleOtherClp:

Data Fields
const int	isOvl	True if provided table must be interpreted as overlay else as object.
const char *	pcHlp	String for a short context sensitive help for this CLP string (converted on EBCDIC systems).
const char *	pcKyw	Pointer to the key word for this string (:alpha:[:alnum:|'_']*).
const char *	pcMan	Pointer to a null-terminated string for a detailed description for this CLP string (in ASCIDOC format, content behind .DESCRIPTION, mainly simply some paragraphs plus .OPTIONS and/or.EXAMPLES) It is recommended to use a header file with a define for this long string. "&{OWN}" and "&{PGM}" are replaced with the current owner and program name. The resulting text is converted on EBCDIC systems).
const char *	pcRot	Pointer to the program/root key word for this string (:alpha:[:alnum:|'_']*).
const TsClpArgument *	psTab	Pointer to the main argument table for this command (defines the semantic for the parser).

Macro Definition Documentation

CLEOTH_CLS

#define CLEOTH_CLS   { NULL, NULL, NULL, NULL, NULL, 0}

Ends a table with other CLP strings.

Definition at line 489 of file CLEDEF.h.

CLEOTH_OPN

#define CLEOTH_OPN

(

name

)

TsCleOtherClp name[]

Starts a table with other CLP strings.

Parameters

[in]

name

Name of this table.

Definition at line 467 of file CLEDEF.h.

CLETAB_OTH

#define CLETAB_OTH	(		rot,
			kyw,
			tab,
			man,
			hlp,
			ovl
	)		{(rot),(kyw),(tab),(man),(hlp),(ovl)},

Defines a appendix for the object or overlay cmd of the root rot with the headline of hdl for a certain other CLP string.
.

Parameters

[in]	rot	Pointer to the program/root key word for this string (:alpha:[:alnum:|'_']*).
[in]	kyw	Pointer to the key word for this string (:alpha:[:alnum:|'_']*).
[in]	tab	Pointer to the main argument table for this CLP string.
[in]	man	Pointer to a null-terminated string for a detailed description for this CLP string (in ASCIDOC format, content behind .DESCRIPTION, mainly simply some paragraphs plus .OPTIONS and/or.EXAMPLES). It is recommended to use a header file with a define for this long string. "&{OWN}" and "&{PGM}" are replaced with the current owner and program name. The resulting text is converted on EBCDIC systems.
[in]	hlp	String for a short context sensitive help for this CLP string (converted on EBCDIC systems). n
[in]	ovl	True if provided table must be interpreted as overlay else as object.

Definition at line 483 of file CLEDEF.h.

Typedef Documentation

TsCleOtherClp

typedef struct CleOtherClp TsCleOtherClp

CLE table structure for other CLP strings.

This structure is used to define a table of CLP strings in order to add as appendix to the generated documentation.