autodoc.git / traditional_manual / chapter_9.html

version» Context lines:

autodoc.git/traditional_manual/chapter_9.html:2191:   <dd class='body--doc'><p>Only effective if you have a history object.</p>   </dd></dl>         <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span>   <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>         <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span>   <span class='homogen--name'><b>enable_history</b></span>   </dt>   <dd><p><code><code class='datatype'>void</code> <b><span class='method'>enable_history</span>(</b><code class='datatype'>array</code>(<code class='datatype'>string</code>)|<code class='object unresolved'>History</code>|<code class='datatype'>int</code> <code class='argument'>hist</code><b>)</b></code></p></dd>   <dt class='head--fixme'>FIXME</dt>
autodoc.git/traditional_manual/chapter_9.html:2367:         <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span>   <span class='homogen--name'><b>message</b></span>   </dt>   <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>         <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span>   <span class='homogen--name'><b>newline</b></span>   </dt>   <dd><p><code><code class='datatype'>string</code> <b><span class='method'>newline</span>(</b><b>)</b></code></p></dd>   <dt class='head--fixme'>FIXME</dt>
autodoc.git/traditional_manual/chapter_9.html:2399:   <dd class='body--fixme'><p>Document this function</p>   </dd></dl>         <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span>   <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("",&nbsp;prompt,&nbsp;attrs)</code>.</p> + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><p><code>edit()</code></p>   </dd></dl>         <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span>   <span class='homogen--name'><b>redisplay</b></span>   </dt>   <dd><p><code><code class='datatype'>void</code> <b><span class='method'>redisplay</span>(</b><code class='datatype'>int</code> <code class='argument'>clear</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>nobackup</code><b>)</b></code></p></dd>   <dt class='head--fixme'>FIXME</dt>
autodoc.git/traditional_manual/chapter_9.html:2509:   <dd class='body--fixme'><p>Document this function</p>   </dd></dl>         <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span>   <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>      <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span>   <span class='homogen--name'><b>backward_char</b></span>   </dt>   <dd><p><code><code class='datatype'>void</code> <b><span class='method'>backward_char</span>(</b><b>)</b></code></p></dd>