Skip to content

Commit 279af05

Browse files
authored
Regenerated LDoc documentation (#89)
Updated config.ld to use the same docs file in the future instead of doc or having to specifiy it. Added module declaration to nakama/socket.lua so the doc file can be generated. Changed module name in nakama/session.lua to match file structure nakama.util.session => nakama.session Regenerated the docs using ldoc
1 parent 6640a74 commit 279af05

14 files changed

Lines changed: 3818 additions & 2577 deletions

config.ld

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,4 @@ title = "SDK API documentation"
55
package = "nakama"
66
description = "Nakama client SDK for Defold"
77
full_description = "Developed by The Defold Foundation and maintained by Heroic Labs."
8+
dir = "docs"

docs/index.html

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,13 @@ <h1>Nakama Defold</h1>
2929

3030

3131

32+
3233
<h2>Modules</h2>
3334
<ul class="nowrap">
3435
<li><a href="modules/nakama.engine.defold.html">nakama.engine.defold</a></li>
3536
<li><a href="modules/nakama.html">nakama</a></li>
3637
<li><a href="modules/nakama.session.html">nakama.session</a></li>
38+
<li><a href="modules/nakama.socket.html">nakama.socket</a></li>
3739
<li><a href="modules/nakama.util.async.html">nakama.util.async</a></li>
3840
<li><a href="modules/nakama.util.base64.html">nakama.util.base64</a></li>
3941
<li><a href="modules/nakama.util.json.html">nakama.util.json</a></li>
@@ -61,7 +63,11 @@ <h2>Modules</h2>
6163
</tr>
6264
<tr>
6365
<td class="name" nowrap><a href="modules/nakama.session.html">nakama.session</a></td>
64-
<td class="summary">Create and check Nakama sessions.</td>
66+
<td class="summary">Create and check sessions.</td>
67+
</tr>
68+
<tr>
69+
<td class="name" nowrap><a href="modules/nakama.socket.html">nakama.socket</a></td>
70+
<td class="summary">Manage sockets</td>
6571
</tr>
6672
<tr>
6773
<td class="name" nowrap><a href="modules/nakama.util.async.html">nakama.util.async</a></td>
@@ -88,8 +94,8 @@ <h2>Modules</h2>
8894
</div> <!-- id="content" -->
8995
</div> <!-- id="main" -->
9096
<div id="about">
91-
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
92-
<i style="float:right;">Last updated 2021-11-05 15:42:41 </i>
97+
<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
98+
<i style="float:right;">Last updated 2025-10-18 15:04:29 </i>
9399
</div> <!-- id="about" -->
94100
</div> <!-- id="container" -->
95101
</body>

docs/ldoc.css

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -294,6 +294,7 @@ pre .library { color: #0e7c6b; }
294294
pre .marker { color: #512b1e; background: #fedc56; font-weight: bold; }
295295
pre .string { color: #8080ff; }
296296
pre .number { color: #f8660d; }
297+
pre .function-name { color: #60447f; }
297298
pre .operator { color: #2239a8; font-weight: bold; }
298299
pre .preprocessor, pre .prepro { color: #a33243; }
299300
pre .global { color: #800080; }

docs/modules/nakama.engine.defold.html

Lines changed: 30 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
<br/>
2727
<h1>Nakama Defold</h1>
2828

29+
2930
<ul>
3031
<li><a href="../index.html">Index</a></li>
3132
</ul>
@@ -41,6 +42,7 @@ <h2>Modules</h2>
4142
<li><strong>nakama.engine.defold</strong></li>
4243
<li><a href="../modules/nakama.html">nakama</a></li>
4344
<li><a href="../modules/nakama.session.html">nakama.session</a></li>
45+
<li><a href="../modules/nakama.socket.html">nakama.socket</a></li>
4446
<li><a href="../modules/nakama.util.async.html">nakama.util.async</a></li>
4547
<li><a href="../modules/nakama.util.base64.html">nakama.util.base64</a></li>
4648
<li><a href="../modules/nakama.util.json.html">nakama.util.json</a></li>
@@ -76,7 +78,11 @@ <h2><a href="#Functions">Functions</a></h2>
7678
<td class="summary">Connect a created socket using web sockets.</td>
7779
</tr>
7880
<tr>
79-
<td class="name" nowrap><a href="#socket_send">socket_send (socket, message, callback)</a></td>
81+
<td class="name" nowrap><a href="#socket_disconnect">socket_disconnect (socket)</a></td>
82+
<td class="summary">Disconnect a created socket</td>
83+
</tr>
84+
<tr>
85+
<td class="name" nowrap><a href="#socket_send">socket_send (socket, message)</a></td>
8086
<td class="summary">Send a socket message.</td>
8187
</tr>
8288
</table>
@@ -197,10 +203,30 @@ <h3>Parameters:</h3>
197203

198204

199205

206+
</dd>
207+
<dt>
208+
<a name = "socket_disconnect"></a>
209+
<strong>socket_disconnect (socket)</strong>
210+
</dt>
211+
<dd>
212+
Disconnect a created socket
213+
214+
215+
<h3>Parameters:</h3>
216+
<ul>
217+
<li><span class="parameter">socket</span>
218+
The socket table, see socket_create.
219+
</li>
220+
</ul>
221+
222+
223+
224+
225+
200226
</dd>
201227
<dt>
202228
<a name = "socket_send"></a>
203-
<strong>socket_send (socket, message, callback)</strong>
229+
<strong>socket_send (socket, message)</strong>
204230
</dt>
205231
<dd>
206232
Send a socket message.
@@ -214,9 +240,6 @@ <h3>Parameters:</h3>
214240
<li><span class="parameter">message</span>
215241
The message string to send.
216242
</li>
217-
<li><span class="parameter">callback</span>
218-
The callback function.
219-
</li>
220243
</ul>
221244

222245

@@ -230,8 +253,8 @@ <h3>Parameters:</h3>
230253
</div> <!-- id="content" -->
231254
</div> <!-- id="main" -->
232255
<div id="about">
233-
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
234-
<i style="float:right;">Last updated 2021-11-05 15:42:41 </i>
256+
<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
257+
<i style="float:right;">Last updated 2025-10-18 15:04:29 </i>
235258
</div> <!-- id="about" -->
236259
</div> <!-- id="container" -->
237260
</body>

0 commit comments

Comments
 (0)