Editing Module:Sandbox/Jeblad/LuaDoc/doc (section)

===Available tags===
A series of different tags are recognized. They capture words or other constructs, and will process the captures specially. The captures will be formatted and linked as necessary. The remaining text is treated as ordinary wikitext.

If a tag taking captures fails to detect a capture, then possible captures will be successively pushed out, ultimately pushing all possible captures into the following text. This can be used in some cases to avoid using a specific capture, but is an indication that the documentation is broken.

It is the intention to support the listed tags, but others can be added later. The block tags from JSdoc could be a source for additional entries.<ref>{{cite web|url=http://usejsdoc.org/#block-tags|website=@use JSDoc|title=Block Tags}}</ref>

; @author<sup>*</sup> : Identify the author of an item. Authors are those that have contributed with content to the item.
; @copyright<sup>*</sup> : Document some copyright information. Copyright is an identification of the entity that is allowed to set the license.
; @license<sup>*</sup> : Identify the license that applies to this code. The license is the document that says why a module can be reused.
; @provenance<sup>*</sup> : Document the history of ownership for the module. Link this to the external source if suitable.
; @release<sup>?</sup> (alt @version) : Identify the release or version number of an item. This is necessary for imported modules.
; @since<sup>?</sup> [''date''|''version''|''revision''] : Document when this feature was added. The date, version, or revision when some functionality was added.
; @deprecated<sup>?</sup> [''date''|''version''|''revision''] : Document when this feature was deprecated. The date, version, or revision is when some functionality become deprecated.
; @var<sup>?</sup> [''word''|''descriptor''] : Describe a variable definition. First field is a type declaration. This implies a variable-class. (Not sure about this one, its like the signature of the function.)
; @field<sup>*</sup> [''word''|''descriptor''] : Describe a table field definition. First field is a type declaration. This implies a variable-class.
; @param<sup>*</sup> [''word''|''descriptor''] (alt @arg, @argument) : Document the parameter to a function. First field is a type declaration. This implies a function-class.
; @returns<sup>*</sup> (alt @return) : Document the return values of a function. Since Lua can return multiple values, this tag could appear more than once. This implies a function-class.
; @see<sup>*</sup> : Refer to some other documentation for more information. This tag spawns an entry possibly with links in a navigation box.
; @usage <''text''> : Describe the usage of the function or variable. This is one of several such free sections. The tag will be localized as necessary. (Not sure about this one, perhaps name the individual modifiers.)

* <sup>*</sup> Zero or more entries
* <sup>+</sup> One or more entries
* <sup>?</sup> Zero or one entry