Template:Lua autodoc/doc

Usage

{{Lua autodoc|file=Module name}}

Examples

{{Lua autodoc|file=Docbunto|code=yes}} yields:

Extended content

{{Lua autodoc|file=Example|code=yes}} yields:

Extended content

{{Lua autodoc|file=Sandbox|code=yes}} yields:

Extended content

Template data

No description.

Template parameters

This template prefers block formatting of parameters.

Parameter		Description	Type	Status
Module Name	1 file	Module page name (without namespace).	String	suggested
Infobox Image	image	Infobox image.	File	optional
Caption	caption	Infobox image caption.	Content	optional
All	all	Include private items in documentation. Default false	Boolean	optional
Boilerplate	boilerplate	Removal of boilerplate (license block comments). Default false	Boolean	optional
Code	code	Only document Docbunto code items - exclude article infobox and lede from rendered documentation. Default false	Boolean	optional
Colon	colon	Parses tags with a `:` suffix and without the `@` prefix. This bypasses the "doctag soup" some authors complain of. Default false	Boolean	optional
No Lua Reference	noluaref	Don't link to the Lua reference manual for types. Default false	Boolean	optional
Plain	plain	Disable Markdown formatting in documentation. Default false	Boolean	optional
Simple	simple	Limit documentation to descriptions only. Removes documentation of subitem tags such as `@param` and `@field`. Default false	Boolean	optional
Sort	sort	Sort documentation items in alphabetical order instead of source code order. Default false	Boolean	optional
Strip	strip	Remove table index in documentation. Default false	Boolean	optional
UList	ulist	Indent subitems as `<ul>` lists (LDoc/JSDoc behaviour) instead of `<dl>` list. Default false	Boolean	optional
Preface	preface	Preface text to insert between lede & item documentation, used to provide usage and code examples.	Content	suggested