Inno Setup Preprocessor: Documentation Conventions

Directive syntax documenting conventions

Directive usage syntax uses the following conventions.

() Group of tokens.
[] Optional token or group of tokens.
| Mutually exclusive tokens.
... Previous token or group of tokens can be repeated.
token Reserved word or symbol(s). Must be typed exactly as shown.
<token> Non-terminal. Its syntax is either shown before, or explained.

Function prototypes documenting conventions

Function prototypes show the function result type, function name and list of formal arguments in parentheses.

Keywords int, str, any, and void respectively specify the (signed 64-bit) integer type, the string type, any type, or the null type (also referred to as nothing, void). When the null type is specified as a function result type then the function does not return a value.

A question mark (?) after the type of an argument means that this argument is optional.