From fcff032c4d9b6b278c4ceeae3e77d5cdce8cb95d Mon Sep 17 00:00:00 2001 From: Jordan Irwin Date: Thu, 27 May 2021 23:44:07 -0700 Subject: [PATCH] Update LuaDoc --- api.lua | 2 +- docs/api.html | 7 ++++--- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/api.lua b/api.lua index 62e8c8f..6c718d9 100644 --- a/api.lua +++ b/api.lua @@ -59,7 +59,7 @@ end -- @function wconfig.write -- @tparam string fname Base filename with optional directory structure (e.g. "my_mod/my_config"). -- @tparam table data Table data to be written to config file. --- @tparam bool styled Outputs in a human-readable format if this is set (default: `true`). +-- @tparam[opt] bool styled Outputs in a human-readable format if this is set (default: `true`). -- @treturn bool `true` if succeeded, `false` if not. function wconfig.write(fname, data, styled) styled = styled ~= false diff --git a/docs/api.html b/docs/api.html index b547dcd..6b876ac 100644 --- a/docs/api.html +++ b/docs/api.html @@ -58,7 +58,7 @@ Reads config file from world directory. - wconfig.write (fname, data, styled) + wconfig.write (fname, data[, styled]) Writes to config file in world directory. @@ -110,7 +110,7 @@
- wconfig.write (fname, data, styled) + wconfig.write (fname, data[, styled])
Writes to config file in world directory. @@ -129,6 +129,7 @@
  • styled bool Outputs in a human-readable format if this is set (default: true). + (optional)
  • @@ -182,7 +183,7 @@
    generated by LDoc 1.4.6 -Last updated 2021-05-27 23:36:42 +Last updated 2021-05-27 23:43:31