section and within annotations for ldoc
This commit is contained in:
@@ -1,5 +1,7 @@
|
||||
Config = {}
|
||||
|
||||
--- Return initial data for Config
|
||||
--- @within Config
|
||||
function Config.initial_data()
|
||||
return {
|
||||
screen = {
|
||||
@@ -24,6 +26,7 @@ function Config.initial_data()
|
||||
end
|
||||
|
||||
--- Restores default configuration settings.
|
||||
--- @within Config
|
||||
function Config.reset()
|
||||
local initial = Config.initial_data()
|
||||
Config.screen = initial.screen
|
||||
@@ -37,12 +40,14 @@ local CONFIG_SPLASH_DURATION_ADDRESS = 3
|
||||
local CONFIG_MAGIC_VALUE = 0xDE
|
||||
|
||||
--- Saves the current configuration.
|
||||
--- @within Config
|
||||
function Config.save()
|
||||
mset(CONFIG_MAGIC_VALUE, CONFIG_MAGIC_VALUE_ADDRESS, CONFIG_SAVE_BANK)
|
||||
mset(Config.timing.splash_duration, CONFIG_SPLASH_DURATION_ADDRESS, CONFIG_SAVE_BANK)
|
||||
end
|
||||
|
||||
--- Loads saved configuration.
|
||||
--- @within Config
|
||||
function Config.load()
|
||||
if mget(CONFIG_MAGIC_VALUE_ADDRESS, CONFIG_SAVE_BANK) == CONFIG_MAGIC_VALUE then
|
||||
Config.timing.splash_duration = mget(CONFIG_SPLASH_DURATION_ADDRESS, CONFIG_SAVE_BANK)
|
||||
|
||||
Reference in New Issue
Block a user