moonwave 1.3.0

Moonwave is a tool for generating documentation from comments in Lua source code.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

--- @class test

local test

--[=[
	auto type
]=]
function test:autoType(x: number, y: { complicated: string, ty: { x: number, y: any } }) end

--[=[
	mixed

	@param y -- extra description for y
]=]
function test:mixed(x: number, y: string): boolean end

--[=[
	multiple returns
]=]
function test:multipleReturns(x: number): (number, string, boolean) end

--[=[
	variadic
]=]
function test:variadic(x: number, ...: string): ...boolean end

--[=[
	question mark

	@param ...? -- example yo
]=]
function test:questionMark(x: number, ...: string) end

--[=[
	free function

	@within test
	@param takes -- this is what it takes, and you ain't got it
]=]
local function free(rakes: number, takes: string): (number, boolean) end

--[=[
	weird formatting

	@within test
	@param secondLine -- A description
]=]
local function weirdFormatting(
	secondLine: number
) end