autodoc.git/
traditional_manual/
chapter_9.html
Branch:
Tag:
Non-build tags
All tags
No tags
2022-07-27
2022-07-27 08:09:13 by Henrik Grubbström (Grubba) <grubba@grubba.org>
1a6bddd4260df7c84b6114740e119ba359e93345 (
49
lines) (+
42
/-
7
)
[
Show
|
Annotate
]
Branch:
master
Documentation
[Stdio.Readline]
: Add doc for read() and write() et al.
2198:
<span class='homogen--name'><b>edit</b></span> </dt> <dd><p><code><code class='datatype'>string</code>|<code class='datatype'>zero</code> <b><span class='method'>edit</span>(</b><code class='datatype'>string</code> <code class='argument'>data</code>, <code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>local_prompt</code>, <code class='datatype'>array</code>(<code class='datatype'>string</code>)|<code class='datatype'>void</code> <code class='argument'>attrs</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>
Read
a
line of data from the input.
</p>
+
</dd>
+
<dt class='head--doc'><span id='p-data'></span>Parameter <code class='parameter'>data</code></dt>
+
<dd></dd><dd class='body--doc'><p>Initial/default value that the user may edit.</p>
+
</dd>
+
<dt class='head--doc'><span id='p-local_prompt'></span>Parameter <code class='parameter'>local_prompt</code></dt>
+
<dd></dd><dd class='body--doc'><p>Alternative prompt. Defaults to the prompt set by <code>set_prompt()</code>.</p>
+
</dd>
+
<dt class='head--doc'><span id='p-attrs'></span>Parameter <code class='parameter'>attrs</code></dt>
+
<dd></dd><dd class='body--doc'><p>Alternative prompt attributes. Defaults to the attributes set
+
by <code>set_prompt()</code>.</p>
+
</dd>
+
<dt class='head--doc'>See also</dt>
+
<dd class='body--doc'><p><code>read()</code></p>
</dd></dl>
2374:
<dd><p><code><code class='datatype'>void</code> <b><span class='method'>message</span>(</b><code class='datatype'>string</code> <code class='argument'>msg</code><b>)</b></code></p></dd> <dt class='head--doc'>Description</dt>
-
<dd class='body--doc'><p>Print a message to the output device</p>
+
<dd class='body--doc'><p>Print a message to the output device
.
</p>
+
</dd>
+
<dt class='head--doc'>See also</dt>
+
<dd class='body--doc'><p><code>write()</code></p>
</dd></dl>
2406:
<span class='homogen--name'><b>read</b></span> </dt> <dd><p><code><code class='datatype'>string</code> <b><span class='method'>read</span>(</b><code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>prompt</code>, <code class='datatype'>array</code>(<code class='datatype'>string</code>)|<code class='datatype'>void</code> <code class='argument'>attrs</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>
Read
a
line of data from the input.</p>
+
</dd>
+
<dt class='head--doc'><span id='p-prompt'></span>Parameter <code class='parameter'>prompt</code></dt>
+
<dd></dd><dd class='body--doc'><p>Alternative prompt. Defaults to the prompt set by <code>set_prompt()</code>.</p>
+
</dd>
+
<dt class='head--doc'><span id='p-attrs'></span>Parameter <code class='parameter'>attrs</code></dt>
+
<dd></dd><dd class='body--doc'><p>Alternative prompt attributes. Defaults to the attributes set
+
by <code>set_prompt()</code>.</p>
+
<p> This
function
is essentially a short hand for
+
<
code class='expr'>edit("", prompt, attrs)<
/
code>.</
p>
+
</dd>
+
<dt class='head--doc'>See also</dt>
+
<dd class='body--doc'><p><code>edit()</code></p>
</dd></dl>
2516:
<span class='homogen--name'><b>write</b></span> </dt> <dd><p><code><code class='datatype'>void</code> <b><span class='method'>write</span>(</b><code class='datatype'>string</code> <code class='argument'>msg</code>, <code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>word_wrap</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>
Print
a
message to the output device with optional word wrap.
</p>
+
</dd>
+
<dt class='head--doc'>See also</dt>
+
<dd class='body--doc'><p><code>message()</code></p>
</dd></dl> <dl><dt><h2 class='header'>Class <b class='ms datatype'>Stdio.Readline.DefaultEditKeys</b></h2> </dt><dd>