{{subnames}}

{% for argumentName in ldoc.modules.iter(argument) do %} {% local displayName = item:display_name_of(argumentName) %} {% local type = ldoc.typename(item:type_of_param(argumentName)) %} {% local default = item:default_of_param(argumentName) %}
• {{displayName}} {% if (type ~= "") then %} {* type *} {% end %} {% if (default and default ~= true) then %} default: {{default}} {% elseif (default) then %} optional {% end %}

  {* ldoc.markup(item.params.map[argumentName]) *}

{% end %}

Returns

{% for i, group in ldoc.ipairs(groups) do %} {% for returnValue in group:iter() do %} {% local type, ctypes = item:return_type(returnValue) %} {% type = ldoc.typename(type) %}
• {% if (type ~= "") then %} {* type *} {% else -- we'll assume that it will return a variable type if none is set %} any {% end %}

  {* ldoc.markup(returnValue.text) *}

{% end %} {% if (i ~= #groups) then %}
OR
{% end %} {% end %}

Example Usage

{* usage *}

See Also

{% for see in ldoc.modules.iter(item.see) do %}
• {{see.label}}
{% end %}