Module:Sandbox/Jeblad/LuaDoc/doc
 | This is a documentation subpage for Module:Sandbox/Jeblad/LuaDoc. It may contain usage information, categories and other content that is not part of the original module page. |
Usage
Usual call for documentation of a single module, like a replacement for the usual documentation page, would be like this
{{#invoke:{{BASEPAGENAME}}|build|{{FULLPAGENAME}}}}
In the actual code there will be specially formatted comments. All comments acted upon by this uses the single line comment. (Is there any reason why we should use other kinds of comments? They are usefull for commenting out blocks? How to describe local functions?)
An initial summary-line is prefixed by three (3) dashes, and double as a marker for the place where the code is to be divided into chunks. The stuff in each chunk is precessed separately. The summary will be marked as such, and it will be possible to use it as a fragment identifier.
A series of different tags are recognized