autodoc.git/ traditional_manual/ chapter_9.html

2002-12-05

2002-12-05 18:08:05 by H. William Welliver III <bill@welliver.org>

• e8d67416226fbee9574989c7aa077a52249d64f5 (223 lines) (+223/-0) ^{[ Show | Annotate ]}
  Branch: 8.0

here we go... more autodocs

Rev: lib/modules/ADT.pmod/struct.pike:1.10
Rev: lib/modules/Protocols.pmod/SNMP.pmod/module.pmod:1.2
Rev: lib/modules/Standards.pmod/ASN1.pmod/Decode.pmod:1.13
Rev: lib/modules/Standards.pmod/ASN1.pmod/Types.pmod:1.20

1358:   <dt class='head--doc'>Throws</dt>   <dd class='body--doc'><p>Throws an error if called on an empty stack.</p>   </dd></dl> + </dd></dl><dl><dt><h2 class='header'>Class <b class='ms datatype'>ADT.struct</b></h2> + </dt><dd><dl class='group--doc'> + <dt class='head--doc'>Description</dt> + <dd class='body--doc'><p>generic data structure</p> + </dd></dl> +  + <hr /> + <dl class='group--doc'> + <dt class='head--type'><span class='homogen--type'>Method</span> + <span class='homogen--name'><b>add_data</b></span> + </dt> + <dd><p><code><code class='datatype'>void</code> <b><span class='method'>add_data</span>(</b><code class='datatype'>string</code> <code class='argument'>s</code><b>)</b></code></p></dd> +  + <dt class='head--doc'>Description</dt> + <dd class='body--doc'><p>Add data to struct</p> + </dd> + <dt class='head--doc'><span id='p-s'></span>Parameter <code class='parameter'>s</code></dt> + <dd></dd><dd class='body--doc'><p>data to add to end of struct</p> + </dd></dl> +  +  + <hr /> + <dl class='group--doc'> + <dt class='head--type'><span class='homogen--type'>Method</span> + <span class='homogen--name'><b>contents</b></span> + </dt> + <dd><p><code><code class='datatype'>string</code> <b><span class='method'>contents</span>(</b><b>)</b></code></p></dd> +  + <dt class='head--doc'>Description</dt> + <dd class='body--doc'><p>Return data, without removing it</p> + </dd> + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'><p>contents of struct</p> + </dd></dl> +  +  + <hr /> + <dl class='group--doc'> + <dt class='head--type'><span class='homogen--type'>Method</span> + <span class='homogen--name'><b>create</b></span> + </dt> + <dd><p><code><span class='object'>ADT.struct</span> <span class='class'>ADT.struct</span><b>(</b><code class='datatype'>void</code>|<code class='datatype'>string</code> <code class='argument'>s</code><b>)</b></code></p></dd> +  + <dt class='head--doc'>Description</dt> + <dd class='body--doc'><p>create a new struct</p> + </dd> + <dt class='head--doc'><span id='p-s'></span>Parameter <code class='parameter'>s</code></dt> + <dd></dd><dd class='body--doc'><p>initial data in struct</p> + </dd></dl> +  +  + <hr /> + <dl class='group--doc'> + <dt class='head--type'><span class='homogen--type'>Method</span> + <span class='homogen--name'><b>get_fix_string</b></span> + </dt> + <dd><p><code><code class='datatype'>string</code> <b><span class='method'>get_fix_string</span>(</b><code class='datatype'>int</code> <code class='argument'>len</code><b>)</b></code></p></dd> + <dt class='head--fixme'>FIXME</dt> + <dd class='body--fixme'><p>document me!</p> + </dd></dl> +  +  + <hr /> + <dl class='group--doc'> + <dt class='head--type'><span class='homogen--type'>Method</span> + <span class='homogen--name'><b>get_fix_uint_array</b></span> + </dt> + <dd><p><code><code class='datatype'>array</code>(<code class='datatype'>mixed</code>) <b><span class='method'>get_fix_uint_array</span>(</b><code class='datatype'>int</code> <code class='argument'>item_size</code>, <code class='datatype'>int</code> <code class='argument'>size</code><b>)</b></code></p></dd> + <dt class='head--fixme'>FIXME</dt> + <dd class='body--fixme'><p>document me!</p> + </dd></dl> +  +  + <hr /> + <dl class='group--doc'> + <dt class='head--type'><span class='homogen--type'>Method</span> + <span class='homogen--name'><b>get_rest</b></span> + </dt> + <dd><p><code><code class='datatype'>string</code> <b><span class='method'>get_rest</span>(</b><b>)</b></code></p></dd> +  + <dt class='head--doc'>Description</dt> + <dd class='body--doc'><p>get remainder of data from struct, clearing the struct</p> + </dd> + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'><p>Remaining contents of struct</p> + </dd></dl> +  +  + <hr /> + <dl class='group--doc'> + <dt class='head--type'><span class='homogen--type'>Method</span> + <span class='homogen--name'><b>get_uint</b></span> + </dt> + <dd><p><code><code class='datatype'>int</code> <b><span class='method'>get_uint</span>(</b><code class='datatype'>int</code> <code class='argument'>len</code><b>)</b></code></p></dd> + <dt class='head--fixme'>FIXME</dt> + <dd class='body--fixme'><p>document me!</p> + </dd></dl> +  +  + <hr /> + <dl class='group--doc'> + <dt class='head--type'><span class='homogen--type'>Method</span> + <span class='homogen--name'><b>get_var_string</b></span> + </dt> + <dd><p><code><code class='datatype'>string</code> <b><span class='method'>get_var_string</span>(</b><code class='datatype'>int</code> <code class='argument'>len</code><b>)</b></code></p></dd> + <dt class='head--fixme'>FIXME</dt> + <dd class='body--fixme'><p>document me!</p> + </dd></dl> +  +  + <hr /> + <dl class='group--doc'> + <dt class='head--type'><span class='homogen--type'>Method</span> + <span class='homogen--name'><b>get_var_uint_array</b></span> + </dt> + <dd><p><code><code class='datatype'>array</code>(<code class='datatype'>mixed</code>) <b><span class='method'>get_var_uint_array</span>(</b><code class='datatype'>int</code> <code class='argument'>item_size</code>, <code class='datatype'>int</code> <code class='argument'>len</code><b>)</b></code></p></dd> + <dt class='head--fixme'>FIXME</dt> + <dd class='body--fixme'><p>document me!</p> + </dd></dl> +  +  + <hr /> + <dl class='group--doc'> + <dt class='head--type'><span class='homogen--type'>Method</span> + <span class='homogen--name'><b>is_empty</b></span> + </dt> + <dd><p><code><code class='datatype'>int</code> <b><span class='method'>is_empty</span>(</b><b>)</b></code></p></dd> +  + <dt class='head--doc'>Description</dt> + <dd class='body--doc'><p>is struct empty?</p> + </dd> + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'><p>1 if empty, 0 otherwise</p> + </dd></dl> +  +  + <hr /> + <dl class='group--doc'> + <dt class='head--type'><span class='homogen--type'>Method</span> + <span class='homogen--name'><b>pop_data</b></span> + </dt> + <dd><p><code><code class='datatype'>string</code> <b><span class='method'>pop_data</span>(</b><b>)</b></code></p></dd> +  + <dt class='head--doc'>Description</dt> + <dd class='body--doc'><p>Return all data in struct, emptying the struct</p> + </dd> + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'><p>contents of struct</p> + </dd></dl> +  +  + <hr /> + <dl class='group--doc'> + <dt class='head--type'><span class='homogen--type'>Method</span> + <span class='homogen--name'><b>put_bignum</b></span> + </dt> + <dd><p><code><code class='datatype'>void</code> <b><span class='method'>put_bignum</span>(</b><code class='datatype'>object</code> <code class='argument'>i</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>len</code><b>)</b></code></p></dd> + <dt class='head--fixme'>FIXME</dt> + <dd class='body--fixme'><p>document me!</p> + </dd></dl> +  +  + <hr /> + <dl class='group--doc'> + <dt class='head--type'><span class='homogen--type'>Method</span> + <span class='homogen--name'><b>put_fix_string</b></span> + </dt> + <dd><p><code><code class='datatype'>void</code> <b><span class='method'>put_fix_string</span>(</b><code class='datatype'>string</code> <code class='argument'>s</code><b>)</b></code></p></dd> + <dt class='head--fixme'>FIXME</dt> + <dd class='body--fixme'><p>document me!</p> + </dd></dl> +  +  + <hr /> + <dl class='group--doc'> + <dt class='head--type'><span class='homogen--type'>Method</span> + <span class='homogen--name'><b>put_fix_uint_array</b></span> + </dt> + <dd><p><code><code class='datatype'>void</code> <b><span class='method'>put_fix_uint_array</span>(</b><code class='datatype'>array</code>(<code class='datatype'>int</code>) <code class='argument'>data</code>, <code class='datatype'>int</code> <code class='argument'>item_size</code><b>)</b></code></p></dd> + <dt class='head--fixme'>FIXME</dt> + <dd class='body--fixme'><p>document me!</p> + </dd></dl> +  +  + <hr /> + <dl class='group--doc'> + <dt class='head--type'><span class='homogen--type'>Method</span> + <span class='homogen--name'><b>put_uint</b></span> + </dt> + <dd><p><code><code class='datatype'>void</code> <b><span class='method'>put_uint</span>(</b><code class='datatype'>int</code> <code class='argument'>i</code>, <code class='datatype'>int</code> <code class='argument'>len</code><b>)</b></code></p></dd> +  + <dt class='head--doc'>Description</dt> + <dd class='body--doc'><p>Append an unsigned integer to struct</p> + </dd> + <dt class='head--doc'><span id='p-i'></span>Parameter <code class='parameter'>i</code></dt> + <dd></dd><dd class='body--doc'><p>unsigned integer to append</p> + </dd> + <dt class='head--doc'><span id='p-len'></span>Parameter <code class='parameter'>len</code></dt> + <dd></dd><dd class='body--doc'><p>length of integer in bytes</p> + </dd></dl> +  +  + <hr /> + <dl class='group--doc'> + <dt class='head--type'><span class='homogen--type'>Method</span> + <span class='homogen--name'><b>put_var_string</b></span> + </dt> + <dd><p><code><code class='datatype'>void</code> <b><span class='method'>put_var_string</span>(</b><code class='datatype'>string</code> <code class='argument'>s</code>, <code class='datatype'>int</code> <code class='argument'>len</code><b>)</b></code></p></dd> + <dt class='head--fixme'>FIXME</dt> + <dd class='body--fixme'><p>document me!</p> + </dd></dl> +  +  + <hr /> + <dl class='group--doc'> + <dt class='head--type'><span class='homogen--type'>Method</span> + <span class='homogen--name'><b>put_var_uint_array</b></span> + </dt> + <dd><p><code><code class='datatype'>void</code> <b><span class='method'>put_var_uint_array</span>(</b><code class='datatype'>array</code>(<code class='datatype'>int</code>) <code class='argument'>data</code>, <code class='datatype'>int</code> <code class='argument'>item_size</code>, <code class='datatype'>int</code> <code class='argument'>len</code><b>)</b></code></p></dd> + <dt class='head--fixme'>FIXME</dt> + <dd class='body--fixme'><p>document me!</p> + </dd></dl>   </dd></dl><dl><dt><h2 class='header'>Module <b class='ms datatype'>ADT.Relation</b></h2>   </dt><dd><dl><dt><h2 class='header'>Class <b class='ms datatype'>ADT.Relation.Binary</b></h2>   </dt><dd>