diff options
author | mitchell <70453897+667e-11@users.noreply.github.com> | 2012-12-01 18:40:57 -0500 |
---|---|---|
committer | mitchell <70453897+667e-11@users.noreply.github.com> | 2012-12-01 18:40:57 -0500 |
commit | cd5994c518513a5adca92bdc14b6d721b95310ac (patch) | |
tree | 24a0553c91332a35788bc12ac57336b829e8fa07 /core/args.lua | |
parent | 6693478c076f4d58b709ac9deba809cd9d84a6ee (diff) |
Updated parameter LuaDoc.
Diffstat (limited to 'core/args.lua')
-rw-r--r-- | core/args.lua | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/core/args.lua b/core/args.lua index b7ddde8d..db0238d1 100644 --- a/core/args.lua +++ b/core/args.lua @@ -24,11 +24,12 @@ local switches = {} -- *long*, respectively. *narg* is the number of arguments the switch accepts, -- *f* is the function called when the switch is tripped, and *description* is -- the switch's description when displaying help. --- @param short String short version of the switch. --- @param long String long version of the switch. +-- @param short The string short version of the switch. +-- @param long The string long version of the switch. -- @param narg The number of expected parameters for the switch. -- @param f The Lua function to run when the switch is tripped. --- @param description Description of the switch for command line help. +-- @param description The string description of the switch for command line +-- help. -- @name register function M.register(short, long, narg, f, description) local t = {f, narg, description} |