Use this template to document functions. You can copy its code from below for easy pasting.


FunctionName

Syntax

type FunctionName(type arg, type arg2, ...)

Arguments

arg
Describe each individual argument, what it may contain and what it means. Including limitations
arg2
Each argument is described individualy.
...
In case the argument is '...', specify what types are allowed.

Return

Describe what, if anything, is returned by this function. Also list the meaning of error codes if applicable.

Description

Describe the function here, including what it does, what the limits are, etc.

Example

int a = FunctionName(1, 2, "test");

Also see

(RelatedFunction)?, (OtherFunction)?

Comments

Everyone can add their comments about their experiences with this function here. Tips for using it are welcome, too.

How it works:


RAW TEMPLATE CODE, FOR EASY COPY/PASTING

= FunctionName =
== Syntax ==
:{{type name(type arg, ...)}}
== Arguments ==
:'''arg'''
::specify.
== Return ==
:specify.
== Description ==
:specify.
== Example ==
== Also see ==
:((specify))
== Comments ==
:Everyone can add their comments about their experiences with this function here. Tips for using it are welcome, too.