WHAT IS NEEDED?

When you submit source code, there are several main entry fields that MMOWorkshop requires. These include:

Brief Description. This is typically a single line and very broadly describes the module. This description is used for all functions, class, etc, within a module. This brief description will be used whenever a group of functions are listed (in a catalogues or index), and should therefore broadly summarise the usage of the function. For example:

Returns the number of days in the month of a Gregorian calendars.

Detailed Description. This is a descriptive explanation of what your module actually does. It should be clear and consistent and written for the benefit of non-programmers. Therefore, you should <strong>not</strong> describe the interface to your program here, that comes later. With technical routines, its always good to include the main equations that underpin your work, you may also like to insert figures that further illustrate the process and expected results. We also recommend adding some history , or references for further reading. For example:

This function calculates the number of days in a month. 

The number of days in each month of a year are always the same, except in a leap year, when February 
gains an extra day. Although we traditionally treat the 29th February as the leap day, a left over
remnant of the Roman calendar means that the theoretical leap day occurs on the 24th February - many 
celebrations occur on this day for this reason.

\par References
http://www.merlyn.demon.co.uk/leapyear.htm#Feb24

Source Code. The source code is naturally the most important piece of information in any submission. Each function you submit, should also contain precise details on the interface you've designed. You should also document any constraints, restrictions or known problems with each function. An example should be given that can be easily compiled and run, demonstrating the features of your modules. Output from this small example should also be given - this also helps other developers check that they have correctly compiled and executed your program.<br> The comments on each function may be incased in the Doxygen style comments, <strong>/*! */</strong>, or entered via the documentation wizard. If you decide to use Doxygen style comments we suggest using the following template (shown in <strong>bold</strong>), replacing all other text as appropriate. If you wish to submit several functions as part of a single package, merely repeat this template leave several lines of blank spaces between each function. <br>

//! {Brief description of function A - typically a copy of description above}
/*!
{Specialisation offered by the function A}

\note {any special restrictions of function A}

\param {details of 1st parameters used}

\param {details of 2nd parameters used}

\param {etc...}

\return {details of any return values}

\Example
\code
{working example}
\endcode

\Output
\code
{output from working example}
\endcode

\author {you}

\todo {further improvement that could be done}

\References:
{any references used}
*/
int functionA(...)
{
 ...
}


//! {Brief description for function B}
/*!
{Details for function B, as above}
*/
int functionB(...)