summaryrefslogtreecommitdiff
path: root/Data/Libraries/LDoc/tests/underscore.lua
blob: 442a7785af5a304679101ce89e280df9bc0fe650 (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
--[[-----------
 testing underscores and Markdown pre-formatting.

 A list may immediately follow a line, if it is indented. Necessary lines
 will also be inserted after resuming current indentation.
  - a list
     - sublist (note the needed indentation for Markdown to recognize this)
     - more
  * of items
  more than one line
  - indeed
  can keep going
Inline _see references_: look at @{_ONE_} and @{table.concat}.
Indented code blocks may also follow immediately.
    function test(a,b)
       return three(a,b)
    end
 @module underscore
]]

----------
-- A function.
-- Can also use @{_TWO_ |second function}
function _ONE_() end

-----------
-- another function
-- @see string.format
function _TWO_() end

------
-- a longer summary.
-- @param a
-- @param b
-- @return one
-- - one-1
-- - one-2
-- @return two
function three(a,b) end