Function documentation format: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
Line 1: | Line 1: | ||
== Notation == | == Notation == | ||
{{func|function_name| | {{func|function_name|par1,par2,par3}} | ||
== Description == | == Description == | ||
Line 6: | Line 6: | ||
== Parameters == | == Parameters == | ||
* | *'''par1''': parameter 1 | ||
*'''par2''': parameter 2 | |||
*'''par3''': parameter 3 | |||
== Return Values == | == Return Values == | ||
'''type''': Returns... | |||
== Example Call == | == Example Call == |
Revision as of 04:24, 31 March 2013
Notation
function_name(par1,par2,par3)
Description
General description of the function.
Parameters
- par1: parameter 1
- par2: parameter 2
- par3: parameter 3
Return Values
type: Returns...
Example Call
// demonstrates...
Example of using the function.