aboutsummaryrefslogtreecommitdiff
path: root/gamemode/shared/concommands.lua
diff options
context:
space:
mode:
authorAlexander Pickering <alexandermpickering@gmail.com>2017-11-07 00:07:35 -0500
committerAlexander Pickering <alexandermpickering@gmail.com>2017-11-07 00:07:35 -0500
commit38a05e947d041f8b9c42e49eb075b972a7e9355c (patch)
tree95ac5ab2b2f323d495745166154a904915bcf686 /gamemode/shared/concommands.lua
parent021d8e86d264e098f9fdce265300ceeb9207506e (diff)
downloadartery-38a05e947d041f8b9c42e49eb075b972a7e9355c.tar.gz
artery-38a05e947d041f8b9c42e49eb075b972a7e9355c.tar.bz2
artery-38a05e947d041f8b9c42e49eb075b972a7e9355c.zip
Added luadocs for shared libraries
Started working on documentation
Diffstat (limited to 'gamemode/shared/concommands.lua')
-rw-r--r--gamemode/shared/concommands.lua9
1 files changed, 6 insertions, 3 deletions
diff --git a/gamemode/shared/concommands.lua b/gamemode/shared/concommands.lua
index 64d9a35..79ea0f3 100644
--- a/gamemode/shared/concommands.lua
+++ b/gamemode/shared/concommands.lua
@@ -1,11 +1,14 @@
---[[
- Various console command helper functions
-]]
+--- Concommand autocomplete helper.
+-- Helps you write console commands' autocomplete functions
+--@module concommands.lua
local fuzzel = nrequire("fuzzel.lua")
local concmd = {}
+--- Generate an autocomplete function.
+-- Generates an autocomplete function based on the strings passed in.
+-- The strings can be passed in as a list of arguments, or in an array.
function concmd.AutocompleteFunction(...)
local opt = {...}
opt = type(opt[1]) == "table" and opt[1] or opt