DocCommenting

Jump to bottom Edit New page

ColonelThirtyTwo edited this page Feb 14, 2012 · 2 revisions

Some specifications for the documentation generator I'm making, as well as a guide for its implementation.

Use LuaDoc-style commenting. Example:

--- Description for function foo.
-- @param x Some type of number thing
function foo(x)
	-- do stuff
end

Tags:

All standard LuaDoc tags
@client, @server, @shared to describe where the function is available

Classes:

All standard LuaDoc classes, minus module
library for SF libraries.
type for SF types.