Template:Apicall/doc

From BZFlagWiki
Revision as of 22:58, 14 December 2008 by Javawizard2539 (Talk | contribs)

Jump to: navigation, search

This template can be used for bzfs api call documentation pages. It contains fields for the parameters of the api call, it's return type (if any), a description for it, and some other api calls that can be referenced. The template supports up to 10 api call parameters, although support for more can be added by editing this template.

To use the template, you must include at least a name parameter, and preferably a description. For example, a call that takes no arguments and returns nothing, and that doesn't have a desctiption, could be declared like this:

{{apicall
| name             = bz_testApiCall()
}}

This would result in the following:


void bz_testApiCall() ()


No description


If we wanted a description for our call, we could do something like this:

{{apicall
| name             = bz_testApiCall()
| description      = This is the description for the function. This particular function doesn't really do anything. The text of this function's description is intentionally long, so that you can see that, when it line-wraps, the text is still indented.
}}

This would result in the following:


void bz_testApiCall() ()


This is the description for the function. This particular function doesn't really do anything. The text of this function's description is intentionally long, so that you can see that, when it line-wraps, the text is still indented.


Now let's say that our function takes some parameters. We can add those like this:

{{apicall
| name             = bz_testApiCall(int theFirstParameter, int theSecondParameter)
| description      = This function does nothing, except that it accepts two numbers as inputs.
| param1           = theFirstParameter
| param1desc       = This number is the first number. It doesn't do anything.
| param2           = theSecondParameter
| param2desc       = This is the second of the two numbers. Like the first number, this one does absolutely nothing.
}}

This would result in the following:


void bz_testApiCall(int theFirstParameter, int theSecondParameter) (theFirstParameter, theSecondParameter)


This function does nothing, except that it accepts two numbers as inputs.

Parameters:
theFirstParameter  -  This number is the first number. It doesn't do anything.
theSecondParameter  -  This is the second of the two numbers. Like the first number, this one does absolutely nothing.

We can also add documentation on the function's return value. This can be done like this:

{{apicall
| name             = int bz_testApiCall(int theFirstParameter, int theSecondParameter)
| description      = This function does nothing, except that it accepts two numbers as inputs.
| param1           = theFirstParameter
| param1desc       = This number is the first number. It doesn't do anything.
| param2           = theSecondParameter
| param2desc       = This is the second of the two numbers. Like the first number, this one does absolutely nothing.
| returns          = A number that means absolutely nothing. It might be 0, or it might be 1, or it might be something else.
}}

Which results in this:


{{{returntype}}} int bz_testApiCall(int theFirstParameter, int theSecondParameter) (theFirstParameter, theSecondParameter)


This function does nothing, except that it accepts two numbers as inputs.

Parameters:
theFirstParameter  -  This number is the first number. It doesn't do anything.
theSecondParameter  -  This is the second of the two numbers. Like the first number, this one does absolutely nothing.
Returns:
A number that means absolutely nothing. It might be 0, or it might be 1, or it might be something else.