autodoc.git/
traditional_manual/
chapter_9.html
Branch:
Tag:
Non-build tags
All tags
No tags
2022-07-28
2022-07-28 06:42:59 by Henrik Grubbström (Grubba) <grubba@grubba.org>
a2a5c0915c57589364bb54e033aa5d8ea072db33 (
23
lines) (+
19
/-
4
)
[
Show
|
Annotate
]
Branch:
master
Documentation
[Stdio.Readline]
: Add doc for set_{non,}blocking().
2469:
<span class='homogen--name'><b>set_blocking</b></span> </dt> <dd><p><code><code class='datatype'>void</code> <b><span class='method'>set_blocking</span>(</b><b>)</b></code></p></dd>
-
<dt class='head--
fixme
'>
FIXME
</dt>
-
<dd class='body--
fixme
'><p>
Document
this
function
</p>
+
+
<dt class='head--
doc
'>
Description
</dt>
+
<dd class='body--
doc
'><p>
Disable
nonblocking
mode.
</p>
+
<p> This is equivalent to calling <code class='expr'>set_nonblocking(0)</code>.</p>
+
</dd>
+
<dt class='head--doc'>See also</dt>
+
<dd class='body--doc'><p><code>set_nonblocking()</code></p>
</dd></dl>
2495:
<span class='homogen--name'><b>set_nonblocking</b></span> </dt> <dd><p><code><code class='datatype'>void</code> <b><span class='method'>set_nonblocking</span>(</b><code class='datatype'>function</code>(<code class='datatype'>string</code>|<code class='datatype'>zero</code>:<code class='datatype'>void</code>)|<code class='datatype'>zero</code> <code class='argument'>f</code><b>)</b></code></p></dd>
-
<dt class='head--
fixme
'>
FIXME
</dt>
-
<dd class='body--
fixme
'><p>
Document
this
function</p>
+
+
<dt class='head--
doc
'>
Description
</dt>
+
<dd class='body--
doc
'><p>
Set
a
function
to be called every time a line is completed.
</p>
+
</dd>
+
<dt class='head--doc'><span id='p-f'></span>Parameter <code class='parameter'>f</code></dt>
+
<dd></dd><dd class='body--doc'><p>Function to call when a line is completed, or <code class='expr'>0</code> (zero) to
+
disable. It will be called with a string when a line is completed,
+
and <code class='expr'>0</code> (zero) when <code>eof()</code> is called.</p>
+
</dd>
+
<dt class='head--doc'>See also</dt>
+
<dd class='body--doc'><p><code>set_blocking()</code>, <code>read()</code></p>
</dd></dl>