summaryrefslogtreecommitdiff
path: root/Data/Libraries/LDoc/tests/styles/multiple.lua
diff options
context:
space:
mode:
Diffstat (limited to 'Data/Libraries/LDoc/tests/styles/multiple.lua')
-rw-r--r--Data/Libraries/LDoc/tests/styles/multiple.lua45
1 files changed, 45 insertions, 0 deletions
diff --git a/Data/Libraries/LDoc/tests/styles/multiple.lua b/Data/Libraries/LDoc/tests/styles/multiple.lua
new file mode 100644
index 0000000..85e12b9
--- /dev/null
+++ b/Data/Libraries/LDoc/tests/styles/multiple.lua
@@ -0,0 +1,45 @@
+------
+-- Various ways of indicating errors
+-- @module multiple
+
+-----
+-- function with return groups.
+-- @treturn[1] string result
+-- @return[2] nil
+-- @return[2] error message
+function mul1 () end
+
+-----
+-- function with return and error tag
+-- @return result
+-- @error message
+function mul2 () end
+
+-----
+-- function with multiple error tags
+-- @return result
+-- @error not found
+-- @error bad format
+function mul3 () end
+
+----
+-- function with inline return and errors
+-- @string name
+function mul4 (name)
+ if type(name) ~= 'string' then
+ --- @error[1] not a string
+ return nil, 'not a string'
+ end
+ if #name == 0 then
+ --- @error[2] zero-length string
+ return nil, 'zero-length string'
+ end
+ --- @treturn string converted to uppercase
+ return name:upper()
+end
+-----
+-- function that raises an error.
+-- @string filename
+-- @treturn string result
+-- @raise 'file not found'
+function mul5(filename) end