Codebase list lua-ldoc / ff60cbd
Modules may return a single _function_ (see tests/funmod.lua) Steve Donovan 7 years ago
2 changed file(s) with 19 addition(s) and 3 deletion(s). Raw diff Collapse all Expand all
291291 end
292292 if item_follows or comment_contains_tags(comment,args) then
293293 tags = extract_tags(comment,args)
294
294295 -- explicitly named @module (which is recommended)
295296 if doc.project_level(tags.class) then
296297 module_found = tags.name
297298 -- might be a module returning a single function!
298299 if tags.param or tags['return'] then
299300 local parms, ret, summ = tags.param, tags['return'],tags.summary
301 local name = tags.name
300302 tags.param = nil
301303 tags['return'] = nil
302 tags.summary = nil
303 add_module(tags,tags.name,false)
304 tags['class'] = nil
305 tags['name'] = nil
306 add_module(tags,name,false)
304307 tags = {
305 summary = summ,
308 summary = '',
306309 name = 'returns...',
307310 class = 'function',
308311 ['return'] = ret,
0 -------
1 -- Summing values.
2 -- Returns a single function.
3 -- @param a first
4 -- @param b second
5 -- @param c third
6 -- @return sum of parameters
7 -- @module funmod
8
9 return function(a,b,c)
10 return a + b + c
11 end
12