Template:API doc function

From ComputerCraft
Jump to: navigation, search
Template documentation[view] [edit] [history] [purge]

Template data

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly error report for this template.

TemplateData for API doc function

Documentation for a ComputerCraft API function. This template will appear differently if its on its own page, or if its transcluded in another page (e.g. an API listing page).

Template parameters

This template has custom formatting.

ParameterDescriptionTypeStatus
Function namename

The function name, including the API namespace.

Default
empty
Example
textutils.slowWrite
Auto value
empty
Stringrequired
Function argumentsargs

The arguments of the function. Use [[Template:Argument]] for these.

Default
empty
Example
{{argument|type=string|name=text}}{{argument|type=number|name=rate|optional=true}}
Auto value
empty
Contentsuggested
Return valuesreturns

The value(s) that this function returns. Use [[Template:Type]] for this.

Default
empty
Example
{{type|nil}}
Auto value
{{type|nil}}
Contentrequired
APIapi

The API that this function is a part of.

Default
empty
Example
textutils
Auto value
Stringsuggested
Part ofpart_of

The mod that implements this function. It is also recommended to include a link to the source code of the function using [[Template:API doc source link]].

Default
empty
Example
[[CC:Tweaked]] {{API doc source link|https://github.com/SquidDev-CC/CC-Tweaked/blob/540e2e25aac43aa8dac8f13f1bc16179819b7a26/src/main/resources/assets/computercraft/lua/rom/apis/textutils.lua#L2}}
Auto value
empty
Contentsuggested
Added inadded_in

The version of the mod that this function was first added in.

Default
empty
Example
1.80pr7
Auto value
Stringoptional
Authorsauthors

The people who created this function.

Default
empty
Example
empty
Auto value
empty
Contentoptional
Contributorscontributors

The people who have contributed to this functions development, or changes/additions to it.

Default
empty
Example
empty
Auto value
empty
Contentoptional
Descriptiondescription

Thorough description of the function and its arguments.

Default
empty
Example
empty
Auto value
empty
Contentrequired
Examplesexamples

Examples showing the functions basic usage, and optionally a more complex usage in practice. Use [[Template:API doc example]] for this.

Default
empty
Example
empty
Auto value
empty
Contentsuggested
Syntaxsyntax

Override for the arguments renderer, do not use unless you know what you are doing.

Default
empty
Example
empty
Auto value
empty
Contentdeprecated
See alsosee_also

Similar functions to look at.

Default
empty
Example
[[textutils.slowPrint]]
Auto value
empty
Contentoptional
Nocatnocat

Whether or not to automatically categorise this function. Don't use unless you know what you are doing.

Default
false
Example
empty
Auto value
empty
Booleanoptional