mirror of
https://github.com/AntumMT/mod-wdata.git
synced 2024-07-02 14:10:28 +02:00
LDoc: change module to topic
This commit is contained in:
Jordan Irwin
parent
d943c37f33
commit
40bab2a311
2
api.lua
2
api.lua
@ -1,7 +1,7 @@
|
||||
|
||||
--- World Data Manager API
|
||||
--
|
||||
-- @module api.lua
|
||||
-- @topic api
|
||||
|
||||
|
||||
-- store formatted world path
|
||||
|
||||
@ -28,159 +28,32 @@
|
||||
|
||||
|
||||
|
||||
<h2>Contents</h2>
|
||||
<ul>
|
||||
<li><a href="#Functions">Functions</a></li>
|
||||
<li><a href="#Tables">Tables</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><strong>api.lua</strong></li>
|
||||
<h2>Topics</h2>
|
||||
<ul class="">
|
||||
<li><a href="topics/api.html">api</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>api.lua</code></h1>
|
||||
<p>World Data Manager API</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
|
||||
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<h2>Topics</h2>
|
||||
<table class="module_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#wdata.read">wdata.read (fname)</a></td>
|
||||
<td class="summary">Reads config file from world directory.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#wdata.write">wdata.write (fname, data[, flags])</a></td>
|
||||
<td class="summary">Writes to config file in world directory.</td>
|
||||
<td class="name" nowrap><a href="topics/api.html">api</a></td>
|
||||
<td class="summary">World Data Manager API</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#Tables">Tables</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#FlagsDef">FlagsDef</a></td>
|
||||
<td class="summary">Flags definition.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "wdata.read"></a>
|
||||
<strong>wdata.read (fname)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Reads config file from world directory.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">fname</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
|
||||
Base filename with optional directory structure (e.g. "my_mod/my_config")
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||
Table with contents read from json file or <code>nil</code>.
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "wdata.write"></a>
|
||||
<strong>wdata.write (fname, data[, flags])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Writes to config file in world directory.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">fname</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
|
||||
Base filename with optional directory structure (e.g. "my_mod/my_config").
|
||||
</li>
|
||||
<li><span class="parameter">data</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||
Table data to be written to config file.
|
||||
</li>
|
||||
<li><span class="parameter">flags</span>
|
||||
<span class="types"><a class="type" href="index.html#FlagsDef">FlagsDef</a></span>
|
||||
|
||||
|
||||
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">bool</span></span>
|
||||
<code>true</code> if succeeded, <code>false</code> if not.
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<h2 class="section-header "><a name="Tables"></a>Tables</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "FlagsDef"></a>
|
||||
<strong>FlagsDef</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Flags definition.
|
||||
|
||||
|
||||
<h3>Fields:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">styled</span>
|
||||
<span class="types"><span class="type">bool</span></span>
|
||||
Outputs in a human-readable format if this is set (default: <code>true</code>).
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
<li><span class="parameter">null_to_table</span>
|
||||
<span class="types"><span class="type">bool</span></span>
|
||||
"null" values will be converted to tables in output (default: <code>false</code>).
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/AntumDeluge/LDoc/tree/custom">LDoc 1.4.6-antum-dev</a></i>
|
||||
<i style="float:right;">Last updated 2021-08-28 19:42:56 </i>
|
||||
<i style="float:right;">Last updated 2021-08-28 19:45:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
||||
190
docs/reference/topics/api.html
Normal file
190
docs/reference/topics/api.html
Normal file
@ -0,0 +1,190 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<html>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||
<head>
|
||||
<title>World Data Manager</title>
|
||||
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<div id="container">
|
||||
|
||||
<div id="product">
|
||||
<div id="product_logo"></div>
|
||||
<div id="product_name"><big><b></b></big></div>
|
||||
<div id="product_description"></div>
|
||||
</div> <!-- id="product" -->
|
||||
|
||||
|
||||
<div id="main">
|
||||
|
||||
|
||||
<!-- Menu -->
|
||||
|
||||
<div id="navigation">
|
||||
<br/>
|
||||
<h1>wdata</h1>
|
||||
|
||||
|
||||
<ul>
|
||||
<li><a href="../index.html">Index</a></li>
|
||||
</ul>
|
||||
|
||||
<h2>Contents</h2>
|
||||
<ul>
|
||||
<li><a href="#Functions">Functions</a></li>
|
||||
<li><a href="#Tables">Tables</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2>Topics</h2>
|
||||
<ul class="">
|
||||
<li><strong>api</strong></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Topic <code>api</code></h1>
|
||||
<p>World Data Manager API</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
|
||||
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#wdata.read">wdata.read (fname)</a></td>
|
||||
<td class="summary">Reads config file from world directory.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#wdata.write">wdata.write (fname, data[, flags])</a></td>
|
||||
<td class="summary">Writes to config file in world directory.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#Tables">Tables</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#FlagsDef">FlagsDef</a></td>
|
||||
<td class="summary">Flags definition.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "wdata.read"></a>
|
||||
<strong>wdata.read (fname)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Reads config file from world directory.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">fname</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
|
||||
Base filename with optional directory structure (e.g. "my_mod/my_config")
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||
Table with contents read from json file or <code>nil</code>.
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "wdata.write"></a>
|
||||
<strong>wdata.write (fname, data[, flags])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Writes to config file in world directory.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">fname</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
|
||||
Base filename with optional directory structure (e.g. "my_mod/my_config").
|
||||
</li>
|
||||
<li><span class="parameter">data</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||
Table data to be written to config file.
|
||||
</li>
|
||||
<li><span class="parameter">flags</span>
|
||||
<span class="types"><a class="type" href="../topics/api.html#FlagsDef">FlagsDef</a></span>
|
||||
|
||||
|
||||
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">bool</span></span>
|
||||
<code>true</code> if succeeded, <code>false</code> if not.
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<h2 class="section-header "><a name="Tables"></a>Tables</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "FlagsDef"></a>
|
||||
<strong>FlagsDef</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Flags definition.
|
||||
|
||||
|
||||
<h3>Fields:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">styled</span>
|
||||
<span class="types"><span class="type">bool</span></span>
|
||||
Outputs in a human-readable format if this is set (default: <code>true</code>).
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
<li><span class="parameter">null_to_table</span>
|
||||
<span class="types"><span class="type">bool</span></span>
|
||||
"null" values will be converted to tables in output (default: <code>false</code>).
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/AntumDeluge/LDoc/tree/custom">LDoc 1.4.6-antum-dev</a></i>
|
||||
<i style="float:right;">Last updated 2021-08-28 19:45:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
Loading…
Reference in New Issue
Block a user