aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBenoit Germain <benoit.germain@ubisoft.com>2024-04-26 10:25:11 +0200
committerBenoit Germain <benoit.germain@ubisoft.com>2024-04-26 10:25:31 +0200
commit8508f12ab2f84ecc4472254564b4585d697b5778 (patch)
treea56bb883f68f56eee307f593958a2d139441d51d
parent17cc38096842c0a28d125fe86025df845610dfd4 (diff)
downloadlanes-8508f12ab2f84ecc4472254564b4585d697b5778.tar.gz
lanes-8508f12ab2f84ecc4472254564b4585d697b5778.tar.bz2
lanes-8508f12ab2f84ecc4472254564b4585d697b5778.zip
Update documentation
Diffstat (limited to '')
-rw-r--r--docs/index.html10
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/index.html b/docs/index.html
index 9b3e5e7..ed1c367 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -185,7 +185,7 @@
185<p> 185<p>
186 <tt>luaopen_lanes_embedded</tt> leaves the module table on the stack. <tt>lanes.configure()</tt> must still be called in order to use Lanes. 186 <tt>luaopen_lanes_embedded</tt> leaves the module table on the stack. <tt>lanes.configure()</tt> must still be called in order to use Lanes.
187 <br/> 187 <br/>
188 If <tt>_luaopen_lanes</tt> is <tt>NULL</tt>, a default loader will simply attempt the equivalent of <tt>luaL_dofile(L, "lanes.lua")</tt>. 188 If <tt>_luaopen_lanes</tt> is <tt>nullptr</tt>, a default loader will simply attempt the equivalent of <tt>luaL_dofile(L, "lanes.lua")</tt>.
189</p> 189</p>
190 190
191<p> 191<p>
@@ -1172,9 +1172,9 @@
1172 <br/> 1172 <br/>
1173 <tt>send()</tt> returns <tt>lanes.cancel_error</tt> if interrupted by a soft cancel request. 1173 <tt>send()</tt> returns <tt>lanes.cancel_error</tt> if interrupted by a soft cancel request.
1174 <br/> 1174 <br/>
1175 If no data is provided after the key, <tt>send()</tt> raises an error. If provided with <tt>linda.null</tt> before the actual key and there is no data to send, <tt>send()</tt> sends a single <tt>nil</tt>. 1175 If no data is provided after the key, <tt>send()</tt> raises an error. If provided with <tt>linda.null</tt> or <tt>lanes.null</tt> before the actual key and there is no data to send, <tt>send()</tt> sends a single <tt>nil</tt>.
1176 <br/> 1176 <br/>
1177 Also, if <tt>linda.null</tt> is sent as data in a linda, it will be read as a <tt>nil</tt>. 1177 Also, if <tt>linda.null</tt> or <tt>lanes.null</tt> is sent as data in a linda, it will be read as a <tt>nil</tt>.
1178</p> 1178</p>
1179 1179
1180<p> 1180<p>
@@ -1391,7 +1391,7 @@ events to a common Linda, but... :).</font>
1391 1391
1392<p> 1392<p>
1393 A very simple way of sleeping when nothing else is available. Is implemented by attempting to read some data in an unused channel of the internal linda used for timers (this linda exists even when timers aren't enabled). 1393 A very simple way of sleeping when nothing else is available. Is implemented by attempting to read some data in an unused channel of the internal linda used for timers (this linda exists even when timers aren't enabled).
1394 Default duration is null, which should only cause a thread context switch. 1394 Default duration is 0, which should only cause a thread context switch.
1395</p> 1395</p>
1396 1396
1397<table border="1" bgcolor="#E0E0FF" cellpadding="10" style="width:50%"><tr><td><pre> 1397<table border="1" bgcolor="#E0E0FF" cellpadding="10" style="width:50%"><tr><td><pre>
@@ -1517,7 +1517,7 @@ events to a common Linda, but... :).</font>
1517</pre></td></tr></table> 1517</pre></td></tr></table>
1518 1518
1519<p> 1519<p>
1520 This has the main drawback of not being LuaJIT-compatible, because some functions registered by LuaJIT are not regular C functions, but specially optimized implementations. As a result, <tt>lua_tocfunction()</tt> returns <tt>NULL</tt> for them. 1520 This has the main drawback of not being LuaJIT-compatible, because some functions registered by LuaJIT are not regular C functions, but specially optimized implementations. As a result, <tt>lua_tocfunction()</tt> returns <tt>nullptr</tt> for them.
1521 <br/> 1521 <br/>
1522 Therefore, Lanes no longer transfers functions that way. Instead, functions are transfered as follows (more or less): 1522 Therefore, Lanes no longer transfers functions that way. Instead, functions are transfered as follows (more or less):
1523</p> 1523</p>