summaryrefslogtreecommitdiff
path: root/Data/Libraries/LDoc/tests/styles/type.lua
blob: cde0dd7deeeb34b495f8dc3e2d820c11cf4dabfa (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
35
36
37
38
39
40
41
42
43
44
45
-----
-- module containing a class
-- @module type

----
-- Our class. Any function or table in this section belongs to `Bonzo`
-- @type Bonzo

----
-- make a new Bonzo.
-- @see Bonzo:dog
-- @string s name of Bonzo
function Bonzo.new(s)
end

-----
-- get a string representation.
-- works with `tostring`
function Bonzo:__tostring()
end

----
-- Another method.
function Bonzo:dog ()

end

----
-- Private method.
-- You need -a flag or 'all=true' to see these
-- @local
function Bonzo:cat ()

end


----
-- A subtable with fields.
-- @table Details
-- @string[readonly] name
-- @int[readonly] age

---
-- This is a simple field/property of the class.
-- @string[opt="Bilbo",readonly] frodo direct access to text