{{mod.name}}

{* ldoc.markup(mod.summary) *}

{* ldoc.markup(mod.description) *}

{% for kind, items, _, summary in mod.kinds() do %}

{{kind}}

{% if summary ~= nil then %}

{* ldoc.markup(summary) *}

{% end %}
{% for item in items() do %}
{* ldoc.item_header(item) *} {% if item.tags.deprecated then %}
Deprecated

This API is deprecated and shouldn't be used anymore.

{% for _, m in ipairs(item.tags.deprecated) do %} {% if m ~= "" then %}

{* ldoc.markup(m) *}

{% end %} {% end %}
{% end %} {% if (item.tags.internal) then %}
Internal

This is an internal function! You are able to use it, but you risk unintended side effects if used incorrectly.

{% end %} {% if (ldoc.descript(item):len() == 0) then %}
Incomplete

Documentation for this section is incomplete and needs expanding.

{% else %}

{* ldoc.markup(ldoc.descript(item)) *}

{% end %}
{# function arguments #} {% if (item.params and #item.params > 0) then %} {% local subnames = mod.kinds:type_of(item).subnames %} {% if (subnames) then %}

{{subnames}}

{% end %} {% for argument in ldoc.modules.iter(item.params) do %} {% local argument, sublist = item:subparam(argument) %} {% end %} {% end %} {# function returns #} {% if ((not ldoc.no_return_or_parms) and item.retgroups) then %} {% local groups = item.retgroups %}

Returns

{% end %} {% if (item.usage) then -- function usage %}

Example Usage

{% for usage in ldoc.modules.iter(item.usage) do %} 
{* usage *}
{% end %} {% end %} {% if (item.see) then %}

See Also

{% end %}
{% end %} {% end %}