diff options
Diffstat (limited to 'Data/Libraries/LDoc/tests/example/laurent/mod1.lua')
-rw-r--r-- | Data/Libraries/LDoc/tests/example/laurent/mod1.lua | 61 |
1 files changed, 61 insertions, 0 deletions
diff --git a/Data/Libraries/LDoc/tests/example/laurent/mod1.lua b/Data/Libraries/LDoc/tests/example/laurent/mod1.lua new file mode 100644 index 0000000..4b5c9b0 --- /dev/null +++ b/Data/Libraries/LDoc/tests/example/laurent/mod1.lua @@ -0,0 +1,61 @@ +--------------------------- +-- Test module providing bonzo.dog. +-- Rest is a longer description +-- @class module +-- @name mod1 + +--- zero function. Two new ldoc features here; item types +-- can be used directly as tags, and aliases for tags +-- can be defined in config.lp. +-- @function zero_fun +-- @param k1 first +-- @param k2 second + +--- first function. Some description +-- @param p1 first parameter +-- @param[opt] p2 second parameter +-- @param[optchain] p3 third parameter +function mod1.first_fun(p1,p2,p3) +end + +------------------------- +-- second function. +-- @param ... var args! +function mod1.second_function(...) +end + +------------ +-- third function. Can also provide parameter comments inline, +-- provided they follow this pattern. +function mod1.third_function( + alpha, -- correction A + beta, -- correction B + gamma -- factor C + ) +end + +----- +-- A useful macro. This is an example of a custom 'kind'. +-- @macro first_macro +-- @see second_function + +---- general configuration table +-- @table config +-- @field A alpha +-- @field B beta +-- @field C gamma +mod1.config = { + A = 1, + B = 2, + C = 3 +} + +--[[-- +Another function. Using a Lua block comment +@param p a parameter +]] +function mod1.zero_function(p) +end + + + |