mirror of
https://github.com/AntumMT/mod-wdata.git
synced 2024-11-19 22:13:45 +01:00
Update LuaDoc
This commit is contained in:
parent
12fde2abc5
commit
fcff032c4d
2
api.lua
2
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
|
||||
|
@ -58,7 +58,7 @@
|
||||
<td class="summary">Reads config file from world directory.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#wconfig.write">wconfig.write (fname, data, styled)</a></td>
|
||||
<td class="name" nowrap><a href="#wconfig.write">wconfig.write (fname, data[, styled])</a></td>
|
||||
<td class="summary">Writes to config file in world directory.</td>
|
||||
</tr>
|
||||
</table>
|
||||
@ -110,7 +110,7 @@
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "wconfig.write"></a>
|
||||
<strong>wconfig.write (fname, data, styled)</strong>
|
||||
<strong>wconfig.write (fname, data[, styled])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Writes to config file in world directory.
|
||||
@ -129,6 +129,7 @@
|
||||
<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>
|
||||
</ul>
|
||||
|
||||
@ -182,7 +183,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2021-05-27 23:36:42 </i>
|
||||
<i style="float:right;">Last updated 2021-05-27 23:43:31 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
Loading…
Reference in New Issue
Block a user