Template:API Function

Description
This template is used for functions provided by the API. It is filled with placeholders that should be replaced with information relevant to the function. This is the description for the function.

Parameters

 * - The description of.
 * - The description of.
 * (optional) - Description of . When a default value for a parameter is nil, it is implied that the parameter is optional.

Return Value
If the function returns anything, state so here.

Examples
Provide examples of how to use the function here. Informal guides beyond the scope of an individual function should be written in separate pages, and linked either here, or in the "See Also" section near the bottom.

Note that these two function calls are identical, as any omitted parameters are set to nil. If the function definition sets a parameter to be nil by default, it implies that parameter is optional.