+# if ldoc.body then -- verbatim HTML as contents; 'non-code' entries
+ $(ldoc.body)
+# elseif module then -- module documentation
+$(ldoc.module_typename(module))
+
+# for item in items() do
+
+#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
+# local kitem = module.kinds:get_item(kind)
+# local has_description = kitem and ldoc.descript(kitem) ~= ""
+ $(ldoc.module_typename(module)) $(module.name)
+$(M(module.summary,module))
+$(M(module.description,module))
+# if module.tags.include then + $(M(ldoc.include_file(module.tags.include))) +# end +# if module.see then +# local li,il = use_li(module.see) +See also:
+-
+# for see in iter(module.see) do
+ $(li)$(see.label)$(il)
+# end -- for
+
Usage:
+-
+# for usage in iter(module.usage) do
+ $(li)
$(ldoc.prettify(usage))$(il) +# end -- for + +# end -- if usage +# if module.info then +
Info:
+-
+# for tag, value in module.info:iter() do
+
- $(tag): $(M(value,module)) +# end +
$(kind)
+| $(display_name(item)) | +$(M(item.summary,item)) | +
$(kind)
+ $(M(module.kinds:get_section_description(kind),nil)) +# if kitem then +# if has_description then +
+ $(M(ldoc.descript(kitem),kitem))
+
+# end
+# if kitem.usage then
+ Usage:
+$(ldoc.prettify(kitem.usage[1]))+# end +# end +
-
+# for item in items() do
+
- + + $(display_name(item)) +# if ldoc.prettify_files and ldoc.is_file_prettified[item.module.file.filename] then + line $(item.lineno) +# end + +
-
+ $(M(ldoc.descript(item),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
+
$(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)
+
- $(name) +# if tp ~= '' then + $(tp) +# end + $(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 +
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)
+ $(li)
+# if rt ~= '' then
+ $(rt)
+# end
+ $(M(r.text,item))$(il)
+# if ctypes then
+
- $(c.name) + $(ldoc.typename(c.type)) + $(M(c.comment,item)) +# end +
-
+# for c in ctypes:iter() do
+
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
+ $(li)$(see.label)$(il)
+# end -- for
+
Usage:
+-
+# for usage in iter(item.usage) do
+ $(li)
$(ldoc.prettify(usage))
$(il) +# end -- for + +# end -- if usage + +
+# end -- for items
+ - $(sublist)$(M(item.params.map[sublist],item))
+
$(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() +| $(m.name) | +$(M(ldoc.strip_header(m.summary),m)) | +