autodoc.git / modref.xml

autodoc.git/modref.xml:1:   <?xml version='1.0' encoding='utf-8'?> - <manual time-stamp='2020-11-29' version='Pike v8.1.13'> + <manual time-stamp='2020-12-07' version='Pike v8.1.13'>    <dir name='./ignored'>    <file name='./ignored/ignored'>    <chapter number='1' title='ignored'>    <autodoc>   <namespace name=''>   <doc><text><p>Symbols implicitly inherited from the virtual base class.</p>   <p> These symbols exist mainly to simplify implementation of    the corresponding lfuns.</p>   </text><group><seealso/><text><p><ref resolved='lfun::'>lfun::</ref></p>   </text></group></doc>
autodoc.git/modref.xml:1911:   <variable name='rsa'><type><object resolved='7.8::Crypto.RSA'>Crypto.RSA</object></type></variable>   </docgroup>   <docgroup homogen-name='set_cipher_suite' homogen-type='method'><doc><text><p>Sets the proper authentication method and cipher specification    for the given cipher <ref resolved='7.8::SSL.session.set_cipher_suite.suite'>suite</ref> and <ref>verison</ref>.</p>   </text></doc>   <method name='set_cipher_suite'>   <arguments><argument name='suite'><type><int/></type></argument><argument name='version'><type><or><object resolved='7.8::SSL.Constants.ProtocolVersion'>ProtocolVersion</object><int/></or></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup> - <docgroup homogen-name='set_compression_method' homogen-type='method'><doc><text><p>Sets the compression method. Currently only <ref resolved='7.8::SSL.Constants.CompressionType.COMPRESSION_null'>COMPRESSION_null</ref> is + <docgroup homogen-name='set_compression_method' homogen-type='method'><doc><text><p>Sets the compression method. Currently only <ref resolved='predef::SSL.Constants.CompressionType.COMPRESSION_null'>COMPRESSION_null</ref> is    supported.</p>   </text></doc>   <method name='set_compression_method'>   <arguments><argument name='compr'><type><int/></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   </class>   <class name='sslfile'>   <doc><text><p>Interface similar to <ref resolved='7.8::Stdio.File'>Stdio.File</ref>.</p>
autodoc.git/modref.xml:12178:   <docgroup homogen-name='_equal' homogen-type='method'><doc><text><p>Compare this iterator with another iterator.</p>   </text><group><param name='iter'/><text><p>The iterator to compare with</p>   </text></group><group><returns/><text><p>Returns <tt>true</tt> if both iterators iterates over the same    objects and are positioned at the same spot.</p>   </text></group></doc>   <method name='_equal'>   <arguments><argument name='iter'><type><mixed/></type></argument></arguments>   <returntype><int><min>0</min><max>1</max></int></returntype>   </method>   </docgroup> + <docgroup homogen-name='_iterator_index' homogen-type='method'><doc><group><returns/><text><p>The index at the current position.</p> + </text></group></doc> + <method name='_iterator_index'> + <arguments/> + <returntype><int/></returntype> + </method> + </docgroup> + <docgroup homogen-name='_iterator_value' homogen-type='method'><doc><group><returns/><text><p>The value at the current position.</p> + </text></group></doc> + <method name='_iterator_value'> + <arguments/> + <returntype><mixed/></returntype> + </method> + </docgroup>   <docgroup homogen-name='`!' homogen-type='method'><doc><group><returns/><text><p>Returns <tt>false</tt> if the iterator has reached the end.</p>   </text></group></doc>   <method name='`!'>   <arguments/>   <returntype><int><min>0</min><max>1</max></int></returntype>   </method>   </docgroup>   <docgroup homogen-name='`+' homogen-type='method'><doc><text><p>Move the iterator <ref resolved='predef::ADT.CircularList.CircularListIterator.`+.steps'>steps</ref> steps forward (negative value on <ref resolved='predef::ADT.CircularList.CircularListIterator.`+.steps'>steps</ref>    will cause the iterator to move backwards) and return the result    as a new iterator.</p>
autodoc.git/modref.xml:12274:   </docgroup>   <docgroup homogen-name='has_previous' homogen-type='method'><doc><group><returns/><text><p>Returns <tt>true</tt> if it is possible to move <ref resolved='predef::ADT.CircularList.CircularListIterator.has_previous.steps'>steps</ref> steps    backwards, if <ref resolved='predef::ADT.CircularList.CircularListIterator.has_previous.steps'>steps</ref> weren't supplied it check if it is    possible to move one step backward.</p>   </text></group></doc>   <method name='has_previous'>   <arguments><argument name='steps'><type><or><void/><int/></or></type></argument></arguments>   <returntype><int><min>0</min><max>1</max></int></returntype>   </method>   </docgroup> - <docgroup homogen-name='index' homogen-type='method'><doc><group><returns/><text><p>The index at the current position.</p> - </text></group></doc> - <method name='index'> - <arguments/> - <returntype><int/></returntype> - </method> - </docgroup> +    <docgroup homogen-name='set_value' homogen-type='method'><doc><text><p>Set the value at the current position.</p>   </text><group><param name='val'/><text><p>The new value</p>   </text></group><group><returns/><text><p>Returns the old value</p>   </text></group></doc>   <method name='set_value'>   <arguments><argument name='val'><type><mixed/></type></argument></arguments>   <returntype><mixed/></returntype>   </method>   </docgroup> - <docgroup homogen-name='value' homogen-type='method'><doc><group><returns/><text><p>The value at the current position.</p> - </text></group></doc> - <method name='value'> - <arguments/> - <returntype><mixed/></returntype> - </method> - </docgroup> +    </class>   </class>   <module name='CritBit'>   <doc><text><p>This module offers CritBit tree implementations for different    key types.</p>   </text><group><note/><text><p>These CritBit trees support prefixes as proper keys. Hence    they should really be called Tries.</p>   </text></group></doc>   <docgroup homogen-name='Tree' homogen-type='method'><doc><text><p>Creates a CritBit tree for keys of type <expr>type</expr>. If no argument is given,    an instance of <ref resolved='predef::ADT.CritBit.StringTree'>ADT.CritBit.StringTree</ref> is returned. Supported types are <expr>"string"</expr>,
autodoc.git/modref.xml:14471:   <docgroup homogen-name='_equal' homogen-type='method'><doc><text><p>Compare this iterator with another iterator.</p>   </text><group><param name='iter'/><text><p>The iterator to compare with.</p>   </text></group><group><returns/><text><p>Returns <tt>true</tt> if both iterators iterates over the same    objects and are positioned at the same spot.</p>   </text></group></doc>   <method name='_equal'>   <arguments><argument name='iter'><type><mixed/></type></argument></arguments>   <returntype><int><min>0</min><max>1</max></int></returntype>   </method>   </docgroup> + <docgroup homogen-name='_iterator_index' homogen-type='method'><doc><group><returns/><text><p>The index at the current position.</p> + </text></group></doc> + <method name='_iterator_index'> + <arguments/> + <returntype><int/></returntype> + </method> + </docgroup> + <docgroup homogen-name='_iterator_value' homogen-type='method'><doc><group><returns/><text><p>The value at the current position.</p> + </text></group></doc> + <method name='_iterator_value'> + <arguments/> + <returntype><mixed/></returntype> + </method> + </docgroup>   <docgroup homogen-name='`!' homogen-type='method'><doc><group><returns/><text><p>Returns <tt>false</tt> if the iterator has reached the end.</p>   </text></group></doc>   <method name='`!'>   <arguments/>   <returntype><int><min>0</min><max>1</max></int></returntype>   </method>   </docgroup>   <docgroup homogen-name='`+' homogen-type='method'><doc><text><p>Move the iterator <ref resolved='predef::ADT.Sequence.SequenceIterator.`+.steps'>steps</ref> steps forward (negative value on <ref resolved='predef::ADT.Sequence.SequenceIterator.`+.steps'>steps</ref>    will cause the iterator to move backwards) and return the result    as a new iterator.</p>
autodoc.git/modref.xml:14567:   </docgroup>   <docgroup homogen-name='has_previous' homogen-type='method'><doc><group><returns/><text><p>Returns <tt>true</tt> if it is possible to move <ref resolved='predef::ADT.Sequence.SequenceIterator.has_previous.steps'>steps</ref> steps    backwards, if <ref resolved='predef::ADT.Sequence.SequenceIterator.has_previous.steps'>steps</ref> weren't supplied it check if it is    possible to move one step backward.</p>   </text></group></doc>   <method name='has_previous'>   <arguments><argument name='steps'><type><or><void/><int/></or></type></argument></arguments>   <returntype><int><min>0</min><max>1</max></int></returntype>   </method>   </docgroup> - <docgroup homogen-name='index' homogen-type='method'><doc><group><returns/><text><p>The index at the current position.</p> - </text></group></doc> - <method name='index'> - <arguments/> - <returntype><int/></returntype> - </method> - </docgroup> +    <docgroup homogen-name='set_value' homogen-type='method'><doc><text><p>Set the value at the current position.</p>   </text><group><param name='val'/><text><p>The new value.</p>   </text></group><group><returns/><text><p>Returns the old value.</p>   </text></group></doc>   <method name='set_value'>   <arguments><argument name='val'><type><mixed/></type></argument></arguments>   <returntype><mixed/></returntype>   </method>   </docgroup> - <docgroup homogen-name='value' homogen-type='method'><doc><group><returns/><text><p>The value at the current position.</p> - </text></group></doc> - <method name='value'> - <arguments/> - <returntype><mixed/></returntype> - </method> - </docgroup> +    </class>   </class>   <class name='Set'>   <doc><text><p>ADT.Set implements a datatype for sets. These sets behave much    like multisets, except that they are restricted to containing only    one instance of each member value.</p>   <p> From a performance viewpoint, it is probably more efficient for a    Pike program to use mappings to serve as sets, rather than using    an ADT.Set,so ADT.Set is mainly provided for the sake of completeness    and code readability.</p>