summaryrefslogtreecommitdiff
path: root/Data/Libraries/LDoc/tests/types.lua
blob: 7555608b300c85f8113470e925b59e6f43c3d964 (plain)
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
-----------------------
-- Module using tparam for typed parameters.
--
-- @module types

--- has typed parameters, `string` and `int`.
-- And never forget `E = m*c^2`.
-- Reference to `two.md.First`
--
-- A reference to `mydata`.
-- @string name
-- @int age
-- @treturn mydata
function _M.first (name,age)

end

--- simple function returning something
-- @return bonzo dog!
function _M.simple()

end


--- a table of this module.
-- @table mydata
_M.mydata = {
    one = 1, -- alpha
    two = 2, -- beta
}