Documentation Policy

[Jay]

So what about the trac? We will use that to document essential things. Where can I find what function, in what file is what located, and how do the several handlers work together. In that way the trac will work as an overview of the gamemode, which can help us find parts of the code, which will be documented inside the code.

So we have to document every function on the trac, include what file it's in, were it's called from, etc? That will waste a lot of development time. There should just be a comment above the function itself and where it's called. E.g:

Handlers/Tips.pwn

Code:

///******************************************************
// ShowPlayerTip
Show's the textdraw for the player which displays the tip. The textdraw is created
from the InitTip function, which is called from OnGameModeInit. This function is called
per-player every minute, in timers.pwn.

// Author: Jay
// Date: 13th Sept
******************************************************///
ShowPlayerTip(playerid)
{
    TextDrawShowForPlayer(playerid, Text:sometip);
}

timer.pwn

Code:

public SecondTimer()
{
    ShowPlayerTip();   // Found in handlers/tip.pwn
}