LUADOC DOWNLOAD

Some tags will be extracted from the following block of code if missing it is the intention to support these. 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. One of the pain points of lua is that aside from being hard for the average person, it is also a pain to document. Is there any reason why we should use other kinds of comments? BTW, since you seem to change IP addresses daily if not more often, it would be easier to communicate with you if you were to create an account.

Uploader:	Grogar
Date Added:	24 January 2013
File Size:	13.42 Mb
Operating Systems:	Windows NT/2000/XP/2003/2003/7/8/10 MacOS 10/X
Downloads:	16336
Price:	Free* [*Free Regsitration Required]

They are useful for commenting out blocks? This module is rated as pre-alpha.

Topic on Extension talk:Scribunto

Usual call for documentation of a single module, like a replacement for the usual documentation page, would be like this. Luuadoc is the intention to support the listed tags, but others can be added later. This was considered and rejected during development.

There are available block comments in Lua, and they can also be used in code documented with LuaDoc. Retrieved from " https: Note that documentation in this module is made to test various aspects of the module itself.

Note that all text is processed as wikitext, and it is possible to link internally and externally as seems luasoc.

This can be used in some cases to avoid using a specific capture, but is an indication that the documentation is broken. Especially, -- it makes no attempt ouadoc do a deeper analysis of the provided code.

Module:LuaDoc - Wikipedia

The above documentation is transcluded from Module: A series of different tags are recognized. Is there any reason why we should use other kinds of comments?

Block comments can be specified a bit more, leading to nested comments. There are no guidelines, and most users seem to focus on documenting how to use the modules rather than how they work.

Perhaps one of the existing libraries would be useful here:. The block tags from JSdoc could be a source for additional entries. Some tags will be extracted from the following block of code if missing it is the intention to support these. Should inline docs be used, those can be supported by wikitext? In Lua a block comment starts like --[[ and run until the corresponding ]]. The stuff in each chunk is precessed separately. It is unfinished, and may or may not be in active development.

Module documentation [ view ] [ edit ] [ history ] [ purge ]. Development Bug tracker Code repository Code docs Statistics.

This page lhadoc last edited on 4 Decemberat Actually, if we add an additional leading hyphen then the comment will be turned into a single line comment. Privacy policy About MediaWiki.

Module:LuaDoc

Subpages of this module. This would enable automatic documentation like the module section of this page generated using a lua script and expluafor example:. All tags with a leading x- will be rejected, no matter if they can be recognised or not.

BTW, since you seem to change IP addresses daily if not more often, it would be easier to communicate with you if you were to create an account. Retrieved from " https: 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.

The following text can be further split and given special markup. To formalize this a little bit we will say that LuaDoc only act upon comments that are on a line by themselves. That leads to a situation whereby the following code can comment out a piece of code.