File: opt.lua

package info (click to toggle)
lua-ldoc 1.5.0-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 928 kB
  • sloc: makefile: 63; ansic: 56
file content (21 lines) | stat: -rw-r--r-- 416 bytes parent folder | download | duplicates (4) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
 
------------
-- ### Functions with options and custom tags.
-- (use `ldoc -c opt.ld opt.lua` for converting.)
--
-- @include opt.md

---- testing [opt]
-- @param one
-- @param[opt] two
-- @param[opt] three
-- @param[opt] four
-- @remark use with caution!
function use_opt (one,two,three,four)
end

--- an explicit table.
-- Can use tparam aliases in table defns
-- @string name
-- @int[opt=0] age
-- @table person2