Template:Nasal doc

The following template description is not displayed when the template is inserted in an article.

Goal

This template is to be used to document Nasal API functions. The underlying aim is to unify Nasal documentation on the wiki.

Usage

{{Nasal doc
| syntax      =
| text        =
| mode        =
| source      =
| version     =
| commit      =
| private     =
| param1      =
...
| param10     =
| param1text  =
...
| param10text  =
| example1text =
| example1     =
...
| example10text =
| example10     =
}}

All parameters are optional.

Basic data

syntax

Syntax of the function.

text

Description of the function.

mode

If this is set to "class", all parameters except source, version, and text become unavailable.

source

When given, should be a repository link template, such as {{flightgear file}} with the text as "Source" (see example below). Ideally, a line number should be given as well.

version

Optional version statement, stating which version of FlightGear the function was added.

commit

Optional commit link. If given, the parameter should use one of {{fgdata commit}}, {{flightgear commit}}, or {{simgear commit}} with the link label "commit."

private

The private function behind the function being documented. It is often named the same, but usually has an underscore (_) preceding it. An example is cmdarg() and _cmdarg().

param(n)

Names of the parameters of the function. There can be up to ten parameters, from param1 to param10.

param(n)text

Description of the parameters. There can be up to ten parameters, from param1text to param10text.

example(n)text

Description of the example. There can be up to ten of these, from example1text to example10text.

example(n)

Examples of the usage of the function. There can be up to ten examples, from example1 to example10.

Examples

=== function() ===
{{Nasal doc
| syntax     = function(a, [b, c]);
| source     = {{flightgear file|t=Source}}
| version    = 3.2
| text       = Returns a value or <code>'''nil'''</code>.
| param1     = a
| param1text = Mandatory argument.
| param2     = b
| param2text = Optional argument.
| param3     = c
| param3text = Optional argument.
| example1   = var variable = function("string");
| example2   = var variable = function("string", 1.234, FlightGear);
}}

function()

_function()

function(a, [b, c]);

Source — Version added: FG 3.2

Returns a value or nil.

a

Mandatory argument.

b

Optional argument.

c

Optional argument.

Examples

Example using just one parameter.

var variable = function("string");

Example of the usage of all parameters.

var variable = function("string", 1.234, FlightGear);