1.4.4.20 The ``Syntax'' Section of a Dictionary Entry

This section describes how to use the defined name in code. The ``Syntax'' description for a generic function describes the lambda list of the generic function itself, while the ``Method Signatures'' describe the lambda lists of the defined methods. The ``Syntax'' description for an ordinary function, a macro, or a special operator describes its parameters.

For example, an operator description might say:

F x y &optional z &key k

This description indicates that the function F has two required parameters, x and y. In addition, there is an optional parameter z and a keyword parameter k.

For macros and special operators, syntax is given in modified BNF notation; see Section 1.4.1.2 (Modified BNF Syntax). For functions a lambda list is given. In both cases, however, the outermost parentheses are omitted, and default value information is omitted.

1.4.4.20.1 Special ``Syntax'' Notations for Overloaded Operators

1.4.4.20.2 Naming Conventions for Rest Parameters

1.4.4.20.3 Requiring Non-Null Rest Parameters in the ``Syntax'' Section

1.4.4.20.4 Return values in the ``Syntax'' Section