This wiki is archived and useful information is being migrated to the main bzflag.org website

Difference between revisions of "Template:Apicall"

From BZFlagWiki
Jump to: navigation, search
Line 1: Line 1:
 
<table border="0" cellspacing="0" cellpadding="1">
 
<table border="0" cellspacing="0" cellpadding="1">
<tr><td colspan="3"><tt>{{{signature|}}}</tt></td></tr>
+
<tr><td colspan="5"><tt>{{{signature|}}}</tt></td></tr>
<tr height="10"><td colspan="3"></td></tr>
+
<tr height="10"><td colspan="5"></td></tr>
<tr><td></td><td colspan="2">{{{description|<i>No description</i>}}}</td></tr>
+
<tr><td></td><td colspan="4">{{{description|<i>No description</i>}}}</td></tr>
 +
<tr height="10"><td colspan="5"></td></tr>
 +
{{{#if:{{{param1|}}}{{{param2|}}}{{{param3|}}}{{{param4|}}}{{{param5|}}}{{{param6|}}}{{{param7|}}}{{{param8|}}}{{{param9|}}}|<tr><td></td><td colspan="4"><b>Parameters: </b></td></tr>}}}
 +
{{{#if:{{{param1|}}}|<tr><td colspan="2"></td><td><tt>{{{param1}}}</tt></td><td>{{{#if:{{{param1desc|}}}|&nbsp; <tt>-</tt> &nbsp;}}}</td><td>{{{param1desc|}}}</td></tr>}}}
 +
{{{#if:{{{returns|}}}|<tr><td></td><td colspan="4"><b>Returns: </b></td></tr><tr><td colspan="2"></td><td colspan="3">{{{returns}}}</td></tr>}}}
 
<includeonly>
 
<includeonly>
 
[[Category:BZFS API Functions]]
 
[[Category:BZFS API Functions]]

Revision as of 08:06, 14 December 2008

No description
Parameters:
{{{param1}}}  -  
Returns:
{{{returns}}}

param is not here

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.