Module:Codedoc/sample

--| Begins a module/file comment, e.g., "this file does *this*". --by Pedro Miller Rabinovitch  --$Id: myfile.lua,v 1.12 2003/10/17 00:13:56 miller Exp $ --TODO lots of stuff.

--% This is the purpose of the function, i.e., what it *does*. --- And this is the second line, which will concatenated to --- the others. --@ first (string) Text of the first parameter --@ what (table) The second parameter is the table used for an --- example --@ [...] (any) Optional parameters to the called whatever --: (number) Number of whatevers done or nil if an error occured function Module:MyFunction( first, what, ... ) end

--% This is the purpose of the second function, i.e., what it *does*. --- And this is the second line, which will concatenated to --- the others. --@ demo (string) Text of the first parameter --@ cool (number) The second parameter is the table used for an --- example --: return string function Module:MyFunction( demo, cool ) return cool .. demo end