Module:Codedoc/sample

Module documentation

[create]

The documentation for this module is missing. Click here to create it.

Editors can experiment in this module's testcases (create) page.
Please add categories to the /doc subpage. Subpages of this module.

--| Sample  Lua source file
--| showing how it works.
--b John doe
--$Id: version info
--TODO: To do notes go here

test = {}

--% Find commentary and relevant lines 
--@ text (string) program code
--@ prefix (string) class of characters to come after `--'
--@ [special] (string) optional special patterns that should also be matched
--: (table) line list
function test:scan_lines( text, prefix, special )
   return {}
end

--% Build function commentary structure from text
--@ text (string) program code
--: (table) function structure
function test:get_functions( text )
	return {}
end