This wiki is out of date, use the continuation of this wiki instead

From FenixWiki

Revision as of 11:46, 1 May 2007 (edit) FCR (Talk | contribs) ← Previous diff		Revision as of 12:30, 1 May 2007 (edit) (undo) Sandman (Talk | contribs) Next diff →
Line 14:		Line 14:
	| '''WORD''' example_word || - Something about this word.		| '''WORD''' example_word || - Something about this word.
	|-		|-
-	| ['''STRING''' example_string] || - Something about this string.	+	| ['''STRING''' example_string] || - Something about this optional string.
	|}		|}
	== Returns ==		== Returns ==
	'''INT''' : Some int.		'''INT''' : Some int.
		+
		+	== Errors ==
		+	List all [[error]]s which could be thrown by use of this function. If you don't know how or the function doesn't throw errors, just leave this section out.
	== Notes ==		== Notes ==

---

Revision as of 12:30, 1 May 2007

Contents 1 Definition 2 Parameters 3 Returns 4 Errors 5 Notes 6 Example

Definition

INT Example_function ( <INT example_int> , <WORD example_word> , [<STRING example_string>] )

Does something.

Here goes a more detailed story about the function.

Parameters

INT example_int	- Something about this int.
WORD example_word	- Something about this word.
[STRING example_string]	- Something about this optional string.

Returns

INT : Some int.

Errors

List all errors which could be thrown by use of this function. If you don't know how or the function doesn't throw errors, just leave this section out.

Notes

Here are some notes, which explains some parts in more depth. Mostly not needed, in which case it can be left out.

Example

Program example;
Begin
    Loop
        frame;
    End
End