summaryrefslogtreecommitdiff
path: root/docgen.lua
diff options
context:
space:
mode:
authorjussi2023-10-15 22:31:17 +0300
committerjussi2023-10-15 22:31:17 +0300
commit95be0403e69b3047a0375cf965dedca0ad876409 (patch)
treeebfc72f0e5ad7c193e679a0744443b367902c09a /docgen.lua
parent7af7e7003131e182efb30bac8c1ff06ac1d667d6 (diff)
downloadreilua-enhanced-95be0403e69b3047a0375cf965dedca0ad876409.tar.gz
reilua-enhanced-95be0403e69b3047a0375cf965dedca0ad876409.tar.bz2
reilua-enhanced-95be0403e69b3047a0375cf965dedca0ad876409.zip
Argumets stored in RL.arg array.
Diffstat (limited to 'docgen.lua')
-rw-r--r--docgen.lua7
1 files changed, 6 insertions, 1 deletions
diff --git a/docgen.lua b/docgen.lua
index abfceb1..1927633 100644
--- a/docgen.lua
+++ b/docgen.lua
@@ -86,7 +86,7 @@ apiFile:write( "# ReiLua API\n" )
-- Usage.
-apiFile:write( "\n## Usage\n" )
+apiFile:write( "\n## Functions\n" )
apiFile:write( "\nApplication needs 'main.lua' or 'main' file as entry point. ReiLua executable will first look it from same directory. Alternatively, path to the folder where \"main.lua\" is located can be given as argument. There are five Lua functions that the framework will call, 'RL.init', 'RL.process', 'RL.draw', 'RL.event', 'RL.log', and 'RL.exit'.\n" )
local FUNC_DESC = {
@@ -121,6 +121,11 @@ luaApiFile:write(
"---"..FUNC_DESC.log.."\n---@param logLevel integer\n---@param message string\nfunction RL.log( logLevel, message ) end\n" )
luaApiFile:write(
"---"..FUNC_DESC.exit.."\nfunction RL.exit() end\n" )
+luaApiFile:write(
+"---"..FUNC_DESC.exit.."\nfunction RL.exit() end\n" )
+
+apiFile:write( "\n## Arguments\n" )
+apiFile:write( "\nArguments are stored in 'RL.arg' array.\n" )
-- Globals.