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

Function example

From FenixWiki

(Difference between revisions)
Jump to: navigation, search
Revision as of 11:34, 1 May 2007 (edit)
FCR (Talk | contribs)

← Previous diff
Current revision (22:31, 12 September 2007) (edit) (undo)
Sandman (Talk | contribs)
m
 
(6 intermediate revisions not shown.)
Line 1: Line 1:
-[[Category:functions]]+[[:Category:functions]]<!--Remove the :-->
==Definition== ==Definition==
-'''INT''' Example_function ( <'''INT''' example_int> , <'''WORD''' example_word> , [<'''STRING''' example_string>] )+'''INT''' example_function ( <'''INT''' example_int> , <'''WORD''' example_word> , [<'''STRING''' example_string>] )
-[Does something.]+Does something.
-[Here goes a more detailed story about the function.]+Here goes a more detailed story about the function.
== Parameters == == Parameters ==
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.
== Notes == == Notes ==
-Here are some notes, which explains some parts in more depth. Mostly not needed, in which case it can be left out.+Here are some notes, which explains some parts in more depth.
== Example == == Example ==
Line 27: Line 30:
Program example; Program example;
Begin Begin
- Loop+ Repeat
frame; frame;
- End+ Until(key(_ESC))
End End
</pre> </pre>
 +Used in example:

Current revision

Category:functions

Contents

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.

Notes

Here are some notes, which explains some parts in more depth.

Example

Program example;
Begin
    Repeat
        frame;
    Until(key(_ESC))
End

Used in example:

Personal tools