return [==[ $(ldoc.title)
# local no_spaces = ldoc.no_spaces # local use_li = ldoc.use_li # local display_name = ldoc.display_name # local iter = ldoc.modules.iter # local M = ldoc.markup
#if module then

$(ldoc.titlecase(module.type)) $(module.name)

# end # if ldoc.body then -- verbatim HTML as contents; 'non-code' entries $(ldoc.body) # elseif module then -- module documentation

$(M(module.summary,module))

$(M(module.description,module))

# if module.usage then # local li,il = use_li(module.usage)

Usage:

    # for usage in iter(module.usage) do $(li)
    $(usage)
    $(il) # end -- for
# end -- if usage # if not ldoc.no_summary then # -- bang out the tables of item types for this module (e.g Functions, Tables, etc) # for kind,items in module.kinds() do

$(kind)

# for item in items() do # end -- for items
$(display_name(item)) $(M(item.summary,item))
#end -- for kinds

#end -- if not no_summary # --- currently works for both Functions and Tables. The params field either contains # --- function parameters or table fields. # local show_return = not ldoc.no_return_or_parms # local show_parms = show_return # for kind, items in module.kinds() do

$(kind)

$(M(module.kinds:get_section_description(kind),nil))
# for item in items() do
$(display_name(item))
$(M(item.summary..' '..(item.description or ''),item)) # if show_parms and item.params and #item.params > 0 then

$(module.kinds:type_of(item).subnames):

    # for p in iter(item.params) do
  • $(p): $(M(item.params[p],item))
    • # end -- for
# end -- if params # if item.usage then # local li,il = use_li(item.usage)

Usage:

    # for usage in iter(item.usage) do $(li)
    $(usage)
    $(il) # end -- for
# end -- if usage # if show_return and item.ret then # local li,il = use_li(item.ret)

Returns:

    # for r in iter(item.ret) do $(li)$(M(r,item))$(il) # end -- for
# end -- if returns # if item.see then # local li,il = use_li(item.see)

see also:

    # for see in iter(item.see) do $(li)$(see.label)$(il) # end -- for
# end -- if see
# end -- for items
# end -- for kinds # else -- if module; project-level contents # if ldoc.description then

$(M(ldoc.description,nil))

# end # if ldoc.full_description then

$(M(ldoc.full_description,nil))

# end # for kind, mods in ldoc.kinds() do

$(kind)

# kind = kind:lower() # for m in mods() do # end -- for modules
$(m.name) $(M(m.summary,m))
# end -- for kinds # end -- if module
generated by LDoc 1.0
]==]