FLAMCLEP-Reference
Command Line Executor/Parser Source Reference
CLE Docu Types

Documentation types used in columns of table below. More...

Macros

#define CLE_DOCTYP_COVER   1U
 Cover page (level must be 1). More...
 
#define CLE_DOCTYP_CHAPTER   2U
 A chapter (level must > 1 and < 6). More...
 
#define CLE_DOCTYP_PROGRAM   10U
 The main program chapter (like chapter but level must < 5). More...
 
#define CLE_DOCTYP_PGMSYNOPSIS   11U
 The program synopsis. More...
 
#define CLE_DOCTYP_PGMSYNTAX   12U
 The program syntax. More...
 
#define CLE_DOCTYP_PGMHELP   13U
 The program help. More...
 
#define CLE_DOCTYP_COMMANDS   20U
 The commands part. More...
 
#define CLE_DOCTYP_OTHERCLP   21U
 Other CLP strings. More...
 
#define CLE_DOCTYP_BUILTIN   22U
 The built-in function section. More...
 
#define CLE_DOCTYP_LEXEMES   30U
 The appendix which prints the lexemes. More...
 
#define CLE_DOCTYP_GRAMMAR   31U
 The appendix which prints the grammar. More...
 
#define CLE_DOCTYP_VERSION   32U
 The appendix which prints the version (pcVsn must be given). More...
 
#define CLE_DOCTYP_ABOUT   33U
 The appendix which prints the about (pcAbo must be given). More...
 
#define CLE_DOCTYP_PROPREMAIN   41U
 The appendix which prints the remaining parameter documentation. More...
 
#define CLE_DOCTYP_PROPDEFAULTS   42U
 The appendix which prints the default parameter documentation. More...
 
#define CLE_DOCTYP_SPECIALCODES   51U
 The appendix which prints the special condition codes. More...
 
#define CLE_DOCTYP_REASONCODES   52U
 The appendix which prints the reason codes (pfMsg must be provided). More...
 

Detailed Description

Documentation types used in columns of table below.

Macro Definition Documentation

◆ CLE_DOCTYP_ABOUT

#define CLE_DOCTYP_ABOUT   33U

The appendix which prints the about (pcAbo must be given).

Definition at line 58 of file CLEDEF.h.

◆ CLE_DOCTYP_BUILTIN

#define CLE_DOCTYP_BUILTIN   22U

The built-in function section.

Definition at line 54 of file CLEDEF.h.

◆ CLE_DOCTYP_CHAPTER

#define CLE_DOCTYP_CHAPTER   2U

A chapter (level must > 1 and < 6).

Definition at line 47 of file CLEDEF.h.

◆ CLE_DOCTYP_COMMANDS

#define CLE_DOCTYP_COMMANDS   20U

The commands part.

Definition at line 52 of file CLEDEF.h.

◆ CLE_DOCTYP_COVER

#define CLE_DOCTYP_COVER   1U

Cover page (level must be 1).

Definition at line 46 of file CLEDEF.h.

◆ CLE_DOCTYP_GRAMMAR

#define CLE_DOCTYP_GRAMMAR   31U

The appendix which prints the grammar.

Definition at line 56 of file CLEDEF.h.

◆ CLE_DOCTYP_LEXEMES

#define CLE_DOCTYP_LEXEMES   30U

The appendix which prints the lexemes.

Definition at line 55 of file CLEDEF.h.

◆ CLE_DOCTYP_OTHERCLP

#define CLE_DOCTYP_OTHERCLP   21U

Other CLP strings.

Definition at line 53 of file CLEDEF.h.

◆ CLE_DOCTYP_PGMHELP

#define CLE_DOCTYP_PGMHELP   13U

The program help.

Definition at line 51 of file CLEDEF.h.

◆ CLE_DOCTYP_PGMSYNOPSIS

#define CLE_DOCTYP_PGMSYNOPSIS   11U

The program synopsis.

Definition at line 49 of file CLEDEF.h.

◆ CLE_DOCTYP_PGMSYNTAX

#define CLE_DOCTYP_PGMSYNTAX   12U

The program syntax.

Definition at line 50 of file CLEDEF.h.

◆ CLE_DOCTYP_PROGRAM

#define CLE_DOCTYP_PROGRAM   10U

The main program chapter (like chapter but level must < 5).

Definition at line 48 of file CLEDEF.h.

◆ CLE_DOCTYP_PROPDEFAULTS

#define CLE_DOCTYP_PROPDEFAULTS   42U

The appendix which prints the default parameter documentation.

Definition at line 60 of file CLEDEF.h.

◆ CLE_DOCTYP_PROPREMAIN

#define CLE_DOCTYP_PROPREMAIN   41U

The appendix which prints the remaining parameter documentation.

Definition at line 59 of file CLEDEF.h.

◆ CLE_DOCTYP_REASONCODES

#define CLE_DOCTYP_REASONCODES   52U

The appendix which prints the reason codes (pfMsg must be provided).

Definition at line 62 of file CLEDEF.h.

◆ CLE_DOCTYP_SPECIALCODES

#define CLE_DOCTYP_SPECIALCODES   51U

The appendix which prints the special condition codes.

Definition at line 61 of file CLEDEF.h.

◆ CLE_DOCTYP_VERSION

#define CLE_DOCTYP_VERSION   32U

The appendix which prints the version (pcVsn must be given).

Definition at line 57 of file CLEDEF.h.