$(M(ldoc.descript(kitem),kitem))

Usage:

$(ldoc.prettify(kitem.usage[1]))

# for item in items() do

🔗

$(display_name(item))

# if ldoc.prettify_files then line $(item.lineno) # end

$(M(item.summary,item))

$(M(item.description,item))

# if ldoc.custom_tags then # for custom in iter(ldoc.custom_tags) do # local tag = item.tags[custom[1]] # if tag and not custom.hidden then # local li,il = use_li(tag)

$(custom.title or custom[1]):

# for value in iter(tag) do $(li)$(custom.format and custom.format(value) or M(value))$(il) # end -- for # end -- if tag

# end -- iter tags # end # if show_parms and item.params and #item.params > 0 then # local subnames = module.kinds:type_of(item).subnames # if subnames then

$(subnames):

# end

# for parm in iter(item.params) do # local param,sublist = item:subparam(parm) # if sublist then

$(sublist)

$(M(item.params.map[sublist],item))

# end # for p in iter(param) do # local name,tp,def = item:display_name_of(p), ldoc.typename(item:type_of_param(p)), item:default_of_param(p)

# if tp ~= '' then $(tp) # end $(name)

$(M(item.params.map[p],item)) # if def == true then (optional) # elseif def then (default $(def)) # end # if item:readonly(p) then readonly # end # end # if sublist then

# end # end -- for

# end -- if params # if show_return and item.retgroups then local groups = item.retgroups

Returns:

# for i,group in ldoc.ipairs(groups) do local li,il = use_li(group)

# for r in group:iter() do local type, ctypes = item:return_type(r); local rt = ldoc.typename(type)
1. # if rt ~= '' then $(rt) # end $(M(r.text,item))$(il) # if ctypes then
   # for c in ctypes:iter() do
   • $(c.name) $(ldoc.typename(c.type)) $(M(c.comment,item))
   # end
   # end -- if ctypes
# end -- for r

# if i < #groups then

Or

# end # end -- for group # end -- if returns # if show_return and item.raise then

Raises:

$(M(item.raise,item)) # end # if item.see then # local li,il = use_li(item.see)

See also:

# for see in iter(item.see) do
• $(see.label)$(il)
# end -- for

# end -- if see # if item.usage then # local li,il = use_li(item.usage)

Usage:

# for usage in iter(item.usage) do $(li)

$(ldoc.prettify(usage))

$(il) # end -- for

# end -- if usage

# end -- for items