Typographical conventions
The following table explains the typographical conventions used in this document.
Typeface | Indicates | Example |
---|---|---|
bold | Commands, executable names, compiler options and pragma directives | If you specify -O3, the compiler assumes -qhot=level=0. To prevent all HOT optimizations with -O3, you must specify -qnohot. |
italics | Parameters or variables whose actual names or values are to be supplied by the user. Italics are also used to introduce new terms | Make sure that you update the size parameter if you return more than the size requested. |
monospace | Programming keywords and library functions, compiler built-in functions, examples of program code, command strings, or user-defined names | If one or two cases of a switch statement are typically executed much more frequently than other cases, break out those cases by handling them separately before the switch statement. |
Syntax diagrams
Throughout this document, diagrams illustrate XL C/C++ syntax. This section will help you to interpret and use those diagrams.
The >>--- symbol indicates the beginning of a command, directive, or statement.
The ---> symbol indicates that the command, directive, or statement syntax is continued on the next line.
The >--- symbol indicates that a command, directive, or statement is continued from the previous line.
The --->< symbol indicates the end of a command, directive, or statement.
Fragments, which are diagrams of syntactical units other than complete commands, directives, or statements, start with the |--- symbol and end with the ---| symbol.
>>-keyword--required_argument----------------------------------><
>>-keyword--+-------------------+------------------------------>< '-optional_argument-'
If you must choose one of the items, one item of the stack is shown on the main path.
>>-keyword--+-required_argument1-+----------------------------->< '-required_argument2-'
If choosing one of the items is optional, the entire stack is shown below the main path.
>>-keyword--+--------------------+----------------------------->< +-optional_argument1-+ '-optional_argument2-'
.-,-------------------. V | >>-keyword----repeatable_argument-+----------------------------><
.-default_argument---. >>-keyword--+-alternate_argument-+-----------------------------><
Sample syntax diagram
The following syntax diagram example shows the syntax for the #pragma comment directive.
(1) (2) (3) (4) (5) .-compiler--------------------------------------------------. (9) (10) >>--------#-------pragma-------comment-------(-------+-date------------------------------------------------------+--)------------>< +-timestamp-------------------------------------------------+ | (6) | '-+-copyright-+-------+-----------------------------------+-' '-user------' | (7) (8) | '-,-------"--token_sequence--"------'
The following examples of the #pragma comment directive are syntactically correct according to the diagram shown above:
#pragma comment(date) #pragma comment(user) #pragma comment(copyright,"This text will appear in the module")