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

Standards

From FenixWiki

Revision as of 11:03, 23 March 2007 by FCR (Talk | contribs)
Jump to: navigation, search

You do not have to feel obligated, but please try to keep your article according to following standards, so that we can get a homogenic look.

Contents

Definition

This is the name of the function, process, variable, ... , and also the name of the article. This block also contains the parameters (the article name doesn't) and return type. You do not need to add the title "definition" you can simply place it on top of the article.

Below is some general information such as what the function's or variable's purpose, or a specific dll you need...

Returns

This is what the function returns; exaplained exactly "what" it returns. for example: a colour, a pixel, an errorcode, etc...

Parameters

These are the parameters explained

Example

A simple example using the function (between <pre> tags). Please do not use links in your code. Refer to the keywords beneath the code in a list. only include relevant keywords. i.e. Do not link to every possible reserved word (as seen in the example code below).

 Program test;
 Begin
   Loop
     frame;
   End
 End
Personal tools