Function documentation format: Difference between revisions

From ENIGMA
Jump to navigation Jump to search
No edit summary
No edit summary
 
(14 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== Notation ==
{{funcTitle|function_name|par1,par2,par3}}
{{func|function_name|par1,par2,par3}}
== Overloads ==
 
This section can be excluded if there are no overloads for the function. The page title should be set using the [[Template:FuncTitle|function title template]].
*[[function_name]]
*[[function_subname]]
*[[function_subname]]
== Description ==
== Description ==
General description of the function.
General description of the function.


== Parameters ==
== Parameters ==
*'''par1''': parameter 1
{| class="funcpars"
*'''par2''': parameter 2
! Parameter !! Data Type !! Description
*'''par3''': parameter 3
|-
| par1 || dtype || first parameter description
|-
| par2 || dtype || second parameter description
|-
| par3 || dtype || third parameter description
|}


== Return Values ==
== Return Values ==
'''type''': Returns...
'''returntype''': Returns...


== Example Call ==
== Example Call ==
<syntaxhighlight lang="gml">
<syntaxhighlight lang="edl">
// demonstrates...
// demonstrates...
Example of using the function.
</syntaxhighlight>
</syntaxhighlight>
{{DISPLAYTITLE:function_name}}
 
__NOTOC__
__NOTOC__
{{Function:GM}}
{{Function:GM}}

Latest revision as of 01:52, 6 August 2013

Overloads

This section can be excluded if there are no overloads for the function. The page title should be set using the function title template.

Description

General description of the function.

Parameters

Parameter Data Type Description
par1 dtype first parameter description
par2 dtype second parameter description
par3 dtype third parameter description

Return Values

returntype: Returns...

Example Call

// demonstrates...