Function documentation format: Difference between revisions

From ENIGMA
Jump to navigation Jump to search
No edit summary
Line 9: Line 9:


== Parameters ==
== Parameters ==
*'''par1''': parameter 1
Parameters should be tabled.
*'''par2''': parameter 2
{| class="wikitable" style="background-color:aliceblue;"
*'''par3''': parameter 3
|-
| '''par1'''
| first parameter description
|-
| '''par2'''
| second parameter description
|-
| '''par3'''
| third parameter description
|}


== Return Values ==
== Return Values ==

Revision as of 11:37, 21 April 2013

Overloads

This section can be excluded if there are no overloads for the function. The page title template set with Template:funcTitle should also be set.

Description

General description of the function.

Parameters

Parameters should be tabled.

par1 first parameter description
par2 second parameter description
par3 third parameter description

Return Values

type: Returns...

Example Call

// demonstrates...
Example of using the function.