autodoc.git / traditional.xml

autodoc.git/traditional.xml:1:   <?xml version='1.0' encoding='utf-8'?> - <manual time-stamp='2022-10-22' version='Pike v8.1.18'> + <manual time-stamp='2022-10-25' version='Pike v8.1.18'>    <dir name='./traditional_manual'>    <file name='./traditional_manual/index.html'>    <chapter title='Table of Contents' unnumbered='1'>    <dl><dt><url href='index.html'>Table of Contents</url></dt>   <dt><url href='chapter_1.html'>1. Introduction</url></dt>   <dd><url href='chapter_1.html#1.1'>1.1. Overview</url></dd>   <dd><url href='chapter_1.html#1.2'>1.2. The history of Pike</url></dd>   <dd><url href='chapter_1.html#1.3'>1.3. A comparison with other languages</url></dd>   <dd><url href='chapter_1.html#1.4'>1.4. What is Pike</url></dd>   <dd><url href='chapter_1.html#1.5'>1.5. Pike License</url></dd>
autodoc.git/traditional.xml:10262:   <arguments/>   <returntype><int/></returntype>   </method>   </docgroup>   <docgroup homogen-name='read' homogen-type='method'>   <method name='read'>   <arguments><argument name='nbytes'><type><or><int><min>0</min><max/></int><void/></or></type></argument></arguments>   <returntype><string/></returntype>   </method>   </docgroup> + <docgroup homogen-name='read_function' homogen-type='method'><doc><text><p>Returns a function that when called will call <ref resolved='predef::Stdio.InputStream.read'>read</ref> with +  nbytes as argument. Can be used to get various callback +  functions, eg for the fourth argument to +  <ref resolved='predef::String.SplitIterator'>String.SplitIterator</ref>.</p> + </text></doc> + <method name='read_function'> + <arguments><argument name='nbytes'><type><int/></type></argument></arguments> + <returntype><function><returntype><string/></returntype></function></returntype> + </method> + </docgroup>   <docgroup homogen-type='method'>   <method name='read_oob'><modifiers><optional/></modifiers>   <arguments><argument name='nbytes'><type><or><int><min>0</min><max/></int><void/></or></type></argument></arguments>   <returntype><string/></returntype>   </method>   <method name='tcgetattr'><modifiers><optional/></modifiers>   <arguments/>   <returntype><or><mapping><indextype><string/></indextype><valuetype><int/></valuetype></mapping><zero/></or></returntype>   </method>   <method name='tcsetattr'><modifiers><optional/></modifiers>
autodoc.git/traditional.xml:108336:    secret.</p>   </text><group><param name='secret'/><text><p>A shared secret between both parties. Typically the same size as    the hash output.</p>   </text></group><group><param name='factor'/><text><p>A moving factor. Defined in <rfc>4226</rfc> to be a counter    synchronized between both parties.</p>   </text></group><group><param name='length'/><text><p>The maximum number of digits of the one-time password. Defaults    to 6. Note that the result is usually 0-padded to this length    for user display purposes.</p>   </text></group></doc>   <method name='hotp'> - <arguments><argument name='secret'><type><string><min>0</min><max>255</max></string></type></argument><argument name='factor'><type><int/></type></argument><argument name='length'><type><or><void/><int/></or></type></argument></arguments> + <arguments><argument name='secret'><type><string><min>0</min><max>255</max></string></type></argument><argument name='factor'><type><int/></type></argument><argument name='length'><type><or><int><min>1</min><max/></int><void/></or></type></argument></arguments>   <returntype><int/></returntype>   </method>   </docgroup>   <docgroup homogen-name='' homogen-type='import'>   <import name=''><classname resolved='predef::'>predef::</classname></import>   </docgroup>   <docgroup homogen-name='__Hash' homogen-type='inherit'>   <inherit name='__Hash'><classname resolved='predef::__builtin.Nettle.__Hash'>.__Hash</classname></inherit>   </docgroup>   <docgroup homogen-name='mgf1' homogen-type='method'><doc><text><p>This is the mask generation function <tt>MFG1</tt> from
autodoc.git/traditional.xml:108423:    important differences. HKDF can use an "info" string that binds a    generated password to a specific use or application (e.g. port    number or cipher suite). It does not however support multiple    rounds of hashing to add computational cost to brute force    attacks.</p>   </text></doc>   <docgroup homogen-name='create' homogen-type='method'><doc><text><p>Initializes the HKDF object with a RFC 5869 2.2    HKDF-Extract(salt, IKM) call.</p>   </text></doc>   <method name='create'><modifiers><protected/></modifiers> - <arguments><argument name='password'><type><string><min>0</min><max>255</max></string></type></argument><argument name='salt'><type><or><void/><string><min>0</min><max>255</max></string></or></type></argument></arguments> + <arguments><argument name='password'><type><string><min>0</min><max>255</max></string></type></argument><argument name='salt'><type><or><string><min>0</min><max>255</max></string><void/></or></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   <docgroup homogen-name='expand' homogen-type='method'><doc><text><p>This is similar to the RFC 5869 2.3 HKDF-Expand(PRK, info, L)    function, but PRK is taken from the object.</p>   </text></doc>   <method name='expand'>   <arguments><argument name='info'><type><string><min>0</min><max>255</max></string></type></argument><argument name='bytes'><type><int/></type></argument></arguments>   <returntype><string><min>0</min><max>255</max></string></returntype>   </method>