Function documentation format: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
(14 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
{{funcTitle|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 == | ||
{| class="funcpars" | |||
! Parameter !! Data Type !! Description | |||
|- | |||
| par1 || dtype || first parameter description | |||
|- | |||
| par2 || dtype || second parameter description | |||
|- | |||
| par3 || dtype || third parameter description | |||
|} | |||
== Return Values == | == Return Values == | ||
''' | '''returntype''': Returns... | ||
== Example Call == | == Example Call == | ||
<syntaxhighlight lang=" | <syntaxhighlight lang="edl"> | ||
// demonstrates... | // demonstrates... | ||
</syntaxhighlight> | </syntaxhighlight> | ||
__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...