autodoc.git / autodoc.xml

version» Context lines:

autodoc.git/autodoc.xml:92792:   <arguments/>   <returntype><int><min>0</min><max/></int></returntype>   </method>   </docgroup>   <docgroup homogen-name='crypt_hash' homogen-type='method'><doc><text><p>Password hashing function in <ref resolved='predef::Nettle.crypt_md5'>crypt_md5()</ref>-style.</p>   <p> Implements the algorithm described in    <url>http://www.akkadia.org/drepper/SHA-crypt.txt</url>.</p>   <p> This is the algorithm used by <tt>crypt(2)</tt> in    methods <tt>$5$</tt> (SHA256) and <tt>$6$</tt> (SHA512).</p>   <p> The <ref resolved='predef::Nettle.Hash.crypt_hash.password'>password</ref> memory will be cleared before released.</p> + <p> Rounds will never be set to less than 1000. If <ref resolved='predef::Nettle.Hash.crypt_hash.rounds'>rounds</ref> is 0 +  it will be set to 5000.</p>   </text><group><seealso/><text><p><ref resolved='predef::Nettle.crypt_md5'>crypt_md5()</ref></p>   </text></group></doc>   <method name='crypt_hash'>   <arguments><argument name='password'><type><string><min>0</min><max>255</max></string></type></argument><argument name='salt'><type><string><min>0</min><max>255</max></string></type></argument><argument name='rounds'><type><int/></type></argument></arguments>   <returntype><string><min>0</min><max>127</max></string></returntype>   </method>   </docgroup>   <docgroup homogen-name='digest_size' homogen-type='method'><doc><text><p>Returns the size of a hash digest.</p>   </text></doc>   <method name='digest_size'>
autodoc.git/autodoc.xml:92827:    <expr>State()-&gt;update(Stdio.read_file(file))-&gt;digest()</expr>,    where State is the hash state class corresponding to this    Hash.</p>   </text><group><param name='bytes'/><text><p>The number of bytes of the file object <ref>file</ref> that should be    hashed. Negative numbers are ignored and the whole file is    hashed.</p>   </text></group><group><seealso/><text><p><ref resolved='predef::Stdio.File'>Stdio.File</ref>, <ref resolved='predef::Nettle.Hash.State.update'>State()-&gt;update()</ref> and    <ref resolved='predef::Nettle.Hash.State.digest'>State()-&gt;digest()</ref>.</p>   </text></group></doc>   <method name='hash'> - <arguments><argument name='source'><type><or><object resolved='predef::Stdio.File'>Stdio.File</object><object resolved='predef::Stdio.Buffer'>Stdio.Buffer</object><object resolved='predef::String.Buffer'>String.Buffer</object><object resolved='predef::System.Memory'>System.Memory</object></or></type></argument><argument name='bytes'><type><or><void/><int/></or></type></argument></arguments> + <arguments><argument name='source'><type><or><object resolved='predef::Stdio.File'>Stdio.File</object><object resolved='predef::Stdio.Buffer'>Stdio.Buffer</object><object resolved='predef::String.Buffer'>String.Buffer</object><object resolved='predef::System.Memory'>System.Memory</object></or></type></argument><argument name='bytes'><type><or><void/><int><min>0</min><max/></int></or></type></argument></arguments>   <returntype><string><min>0</min><max>255</max></string></returntype>   </method>   </docgroup>   <docgroup homogen-name='Hash' homogen-type='inherit'>   <inherit name='Hash'><classname resolved='predef::__builtin.Nettle.Hash'>__builtin.Nettle.Hash</classname></inherit>   </docgroup>   <docgroup homogen-name='name' homogen-type='method'><doc><text><p>Returns a human readable name for the algorithm.</p>   </text></doc>   <method name='name'>   <arguments/>
autodoc.git/autodoc.xml:92850:   </docgroup>   <class name='State'>   <doc><text><p>Base class for hashing contexts.</p>   </text></doc>   <docgroup homogen-name='digest' homogen-type='method'><doc><text><p>Generates a digest, and resets the hashing contents.</p>   </text><group><param name='length'/><text><p>If the length argument is provided, the digest is truncated    to the given length.</p>   </text></group><group><returns/><text><p>The digest.</p>   </text></group></doc>   <method name='digest'> - <arguments><argument name='length'><type><or><int/><void/></or></type></argument></arguments> + <arguments><argument name='length'><type><or><int><min>0</min><max/></int><void/></or></type></argument></arguments>   <returntype><string><min>0</min><max>255</max></string></returntype>   </method>   </docgroup>   <docgroup homogen-name='State' homogen-type='inherit'>   <inherit name='State'><classname resolved='predef::__builtin.Nettle.__Hash.State'>Hash::State</classname></inherit>   </docgroup>   <docgroup homogen-name='update' homogen-type='method'><doc><text><p>Hashes more data.</p>   </text><group><returns/><text><p>Returns <expr>this</expr> in order to simplify chaining    of function calls.</p>   </text></group></doc>