UNPKG

codo

Version:

A CoffeeScript documentation generator.

github.com/coffeedoc/codo

coffeedoc/codo

156 lines • 4.53 kB
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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
[ { "file": "spec/_templates/methods/overload_method.coffee", "methods": [], "variables": [] }, { "file": "spec/_templates/methods/overload_method.coffee", "name": "Example.Overload", "methods": [ { "file": "spec/_templates/methods/overload_method.coffee", "name": "set", "bound": false, "documentation": { "comment": "This is a generic Store set method.\n\nThis should be more description for the method itself, and overload\nshouldn't have messed it up.", "summary": "This is a generic Store set method.", "overloads": [ { "signature": "set(key, value)", "documentation": { "params": [ { "type": "Symbol", "name": "key", "description": "describe key param" }, { "type": "Object", "name": "value", "description": "describe value param" }, { "type": "Object", "name": "options", "description": "the options" } ], "options": { "options": [ { "type": "String", "name": "test", "description": "the test option" } ] }, "comment": "Sets a value on key", "summary": "Sets a value on key" } }, { "signature": "set(value)", "documentation": { "params": [ { "type": "Object", "name": "value", "description": "describe value param" } ], "returns": { "type": "Boolean", "description": "true when success" }, "comment": "Sets a value on the default key `:foo`", "summary": "Sets a value on the default key `:foo`" } } ] }, "kind": "dynamic", "parameters": [ { "name": "args", "splat": true } ] } ], "variables": [], "properties": [], "includes": [], "extends": [], "concerns": [] }, { "file": "spec/_templates/methods/overload_method.coffee", "name": "set", "bound": false, "documentation": { "comment": "This is a generic Store set method.\n\nThis should be more description for the method itself, and overload\nshouldn't have messed it up.", "summary": "This is a generic Store set method.", "overloads": [ { "signature": "set(key, value)", "documentation": { "params": [ { "type": "Symbol", "name": "key", "description": "describe key param" }, { "type": "Object", "name": "value", "description": "describe value param" }, { "type": "Object", "name": "options", "description": "the options" } ], "options": { "options": [ { "type": "String", "name": "test", "description": "the test option" } ] }, "comment": "Sets a value on key", "summary": "Sets a value on key" } }, { "signature": "set(value)", "documentation": { "params": [ { "type": "Object", "name": "value", "description": "describe value param" } ], "returns": { "type": "Boolean", "description": "true when success" }, "comment": "Sets a value on the default key `:foo`", "summary": "Sets a value on the default key `:foo`" } } ] }, "kind": "dynamic", "parameters": [ { "name": "args", "splat": true } ] } ]