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

From FenixWiki

Revision as of 12:31, 1 May 2007 (edit) Sandman (Talk | contribs) m ← Previous diff		Revision as of 00:24, 24 July 2007 (edit) (undo) Sandman (Talk | contribs) Next diff →
Line 6:		Line 6:
	NOTE:		NOTE:
	In the WikiCode, before a new section there is one empty line and after there is one or none.		In the WikiCode, before a new section there is one empty line and after there is one or none.
-	Categories can either be at the top or the bottom in the WikiCode.	+	Categories can either be at the top or the bottom in the WikiCode, but preferred is top as most of the pages have that.
	Add a function to the category "functions" and to any other it applies (like "networkdllfunctions"):		Add a function to the category "functions" and to any other it applies (like "networkdllfunctions"):
	[[Category:functions]]		[[Category:functions]]
Line 25:		Line 25:
	"Does something" is a small summary of the function, in one sentence.		"Does something" is a small summary of the function, in one sentence.
	Then a white line and then a more indepth story about the function.		Then a white line and then a more indepth story about the function.
-	The "[]" indicate an optional parameter.	+	The "[]" indicate an optional parameter. Format WikiCode function definition:
		+	'''DATATYPE''' Example_function ( <'''PARAMETERTYPE''' parametername> , [<'''PARAMETERTYPE''' parametername>] )
		+	Notice the spaces around the '(', ',' and ')'.
	</pre>		</pre>
Line 44:		Line 46:
	== Returns ==		== Returns ==
	'''INT''' : Some int.		'''INT''' : Some int.
		+	{|
		+	| 0 || - Error.
		+	|-
		+	| !0 || - Success.
		+	|}
	<pre>		<pre>
Line 56:		Line 63:
	== Errors ==		== 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.	+	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. If you're certain it errors something, leave a notice that it errors something, but you don't know what.
	== Notes ==		== Notes ==

---

Revision as of 00:24, 24 July 2007

Up to Standards

Click here to get the template for this standard.

NOTE:
In the WikiCode, before a new section there is one empty line and after there is one or none.
Categories can either be at the top or the bottom in the WikiCode, but preferred is top as most of the pages have that.
Add a function to the category "functions" and to any other it applies (like "networkdllfunctions"):
[[Category:functions]]

When internally linking to a function, do it like so, using the "()":
[[functionname]]()

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.

NOTE:
"Does something" is a small summary of the function, in one sentence.
Then a white line and then a more indepth story about the function.
The "[]" indicate an optional parameter. Format WikiCode function definition:
'''DATATYPE''' Example_function ( <'''PARAMETERTYPE''' parametername> , [<'''PARAMETERTYPE''' parametername>] )
Notice the spaces around the '(', ',' and ')'.

Parameters

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

NOTE:
Use a list, it will result in a much better look. The "-" could be left out, but actually looks nice.

Returns

INT : Some int.

0	- Error.
!0	- Success.

NOTE:
If it returns a code, like an errorcode, you can make a list:
{|
| some errorcode || - blabla
|-
| another || - yadayada
|}

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. If you're certain it errors something, leave a notice that it errors something, but you don't know what.

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

NOTE:
Please keep "tabs" at 4 spaces. Try to make the code look tidy and readable. Under the code,
outside the pre-tags, list the functions used and possible other useful pages, like the page
about pointers if the example relies on the knowledge of pointers. Like so:
Used in example: [[new_map]](), [[map_clear]](), [[pointer]]