From 40bab2a3119fdcfcadea0efd84f6531504141922 Mon Sep 17 00:00:00 2001
From: Jordan Irwin
Date: Sat, 28 Aug 2021 19:47:00 -0700
Subject: [PATCH] LDoc: change module to topic
---
api.lua | 2 +-
docs/reference/index.html | 143 ++-----------------------
docs/reference/topics/api.html | 190 +++++++++++++++++++++++++++++++++
3 files changed, 199 insertions(+), 136 deletions(-)
create mode 100644 docs/reference/topics/api.html
diff --git a/api.lua b/api.lua
index 74cbbda..dc4aef9 100644
--- a/api.lua
+++ b/api.lua
@@ -1,7 +1,7 @@
--- World Data Manager API
--
--- @module api.lua
+-- @topic api
-- store formatted world path
diff --git a/docs/reference/index.html b/docs/reference/index.html
index 534cb88..bcca54b 100644
--- a/docs/reference/index.html
+++ b/docs/reference/index.html
@@ -28,159 +28,32 @@
-Contents
-
-Modules
-
- - api.lua
+Topics
+
-
Module api.lua
-
World Data Manager API
-
-
-
-
-
+Topics
+
-
-
-
-
-
-
-
-
-
-
- -
-
- wdata.read (fname)
-
- -
- Reads config file from world directory.
-
-
-
Parameters:
-
- - fname
- string
- Base filename with optional directory structure (e.g. "my_mod/my_config")
-
-
-
- Returns:
-
-
- table
- Table with contents read from json file or nil
.
-
-
-
-
-
-
- -
-
- wdata.write (fname, data[, flags])
-
- -
- Writes to config file in world directory.
-
-
-
Parameters:
-
- - fname
- string
- Base filename with optional directory structure (e.g. "my_mod/my_config").
-
- - data
- table
- Table data to be written to config file.
-
- - flags
- FlagsDef
-
-
-
- (optional)
-
-
-
- Returns:
-
-
- bool
- true
if succeeded, false
if not.
-
-
-
-
-
-
-
-
-
-
- -
-
- FlagsDef
-
- -
- Flags definition.
-
-
-
Fields:
-
- - styled
- bool
- Outputs in a human-readable format if this is set (default:
true
).
- (optional)
-
- - null_to_table
- bool
- "null" values will be converted to tables in output (default:
false
).
- (optional)
-
-
-
-
-
-
-
-
-
-
generated by LDoc 1.4.6-antum-dev
-
Last updated 2021-08-28 19:42:56
+
Last updated 2021-08-28 19:45:59
+
+
+
+
+
+
+
+
+
+
+
+
+
+
wdata
+
+
+
+
+
Contents
+
+
+
+
Topics
+
+
+
+
+
+
+
Topic api
+
World Data Manager API
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ -
+
+ wdata.read (fname)
+
+ -
+ Reads config file from world directory.
+
+
+
Parameters:
+
+ - fname
+ string
+ Base filename with optional directory structure (e.g. "my_mod/my_config")
+
+
+
+ Returns:
+
+
+ table
+ Table with contents read from json file or nil
.
+
+
+
+
+
+
+ -
+
+ wdata.write (fname, data[, flags])
+
+ -
+ Writes to config file in world directory.
+
+
+
Parameters:
+
+ - fname
+ string
+ Base filename with optional directory structure (e.g. "my_mod/my_config").
+
+ - data
+ table
+ Table data to be written to config file.
+
+ - flags
+ FlagsDef
+
+
+
+ (optional)
+
+
+
+ Returns:
+
+
+ bool
+ true
if succeeded, false
if not.
+
+
+
+
+
+
+
+
+
+
+ -
+
+ FlagsDef
+
+ -
+ Flags definition.
+
+
+
Fields:
+
+ - styled
+ bool
+ Outputs in a human-readable format if this is set (default:
true
).
+ (optional)
+
+ - null_to_table
+ bool
+ "null" values will be converted to tables in output (default:
false
).
+ (optional)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/reference/topics/api.html b/docs/reference/topics/api.html
new file mode 100644
index 0000000..d5e43d4
--- /dev/null
+++ b/docs/reference/topics/api.html
@@ -0,0 +1,190 @@
+
+
+
+