summaryrefslogtreecommitdiff
path: root/Data/Libraries/LDoc/tests/styles/opt.lua
diff options
context:
space:
mode:
Diffstat (limited to 'Data/Libraries/LDoc/tests/styles/opt.lua')
-rw-r--r--Data/Libraries/LDoc/tests/styles/opt.lua21
1 files changed, 21 insertions, 0 deletions
diff --git a/Data/Libraries/LDoc/tests/styles/opt.lua b/Data/Libraries/LDoc/tests/styles/opt.lua
new file mode 100644
index 0000000..6cdba2d
--- /dev/null
+++ b/Data/Libraries/LDoc/tests/styles/opt.lua
@@ -0,0 +1,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
+