autodoc.git / autodoc.xml

version» Context lines:

autodoc.git/autodoc.xml:1103:   </docgroup>   </class>   <class name='DES3'>   <docgroup homogen-name='CBC' homogen-type='inherit'>   <inherit name='CBC'><classname resolved='8.0::Crypto.CBC'>Crypto.CBC</classname></inherit>   </docgroup>   </class>   <class name='DHKeyExchange'>   <doc><text><p>Implements Diffie-Hellman key-exchange.</p>   <p> The following key exchange methods are implemented here: -  <ref resolved='predef::SSL.Constants.KeyExchangeType.KE_dhe_dss'>KE_dhe_dss</ref>, <ref resolved='predef::SSL.Constants.KeyExchangeType.KE_dhe_rsa'>KE_dhe_rsa</ref> and <ref resolved='predef::SSL.Constants.KeyExchangeType.KE_dh_anon'>KE_dh_anon</ref>.</p> +  <ref resolved='7.8::SSL.Constants.KeyExchangeType.KE_dhe_dss'>KE_dhe_dss</ref>, <ref resolved='7.8::SSL.Constants.KeyExchangeType.KE_dhe_rsa'>KE_dhe_rsa</ref> and <ref resolved='7.8::SSL.Constants.KeyExchangeType.KE_dh_anon'>KE_dh_anon</ref>.</p>   </text></doc>   <docgroup homogen-name='create' homogen-type='method'>   <method name='create'><modifiers><protected/></modifiers>   <arguments><argument name='p'><type><object resolved='7.8::SSL.Cipher.DHParameters'>DHParameters</object></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   </class>   <class name='DHParameters'>   <doc><text><p>Diffie-Hellman parameters.</p>
autodoc.git/autodoc.xml:1720:   <variable name='client_cert_distinguished_names'><type><array><valuetype><string/></valuetype></array></type></variable>   </docgroup>   <docgroup homogen-type='variable'><doc><text><p>Random cookies, sent and received with the hello-messages.</p>   </text></doc>   <variable name='client_random'><type><string/></type></variable>   <variable name='server_random'><type><string/></type></variable>   </docgroup>   <docgroup homogen-name='create' homogen-type='method'><doc><group><param name='is_server'/><text><p>Whether this is the server end of the connection or not.</p>   </text></group><group><param name='ctx'/><text><p>The context for the connection.</p>   </text></group><group><param name='min_version'/><text><p>Minimum version of SSL to support. -  Defaults to <ref resolved='predef::SSL.Constants.ProtocolVersion.PROTOCOL_SSL_3_0'>Constants.PROTOCOL_SSL_3_0</ref>.</p> +  Defaults to <ref resolved='7.8::SSL.Constants.ProtocolVersion.PROTOCOL_SSL_3_0'>Constants.PROTOCOL_SSL_3_0</ref>.</p>   </text></group><group><param name='max_version'/><text><p>Maximum version of SSL to support.    Defaults to <ref resolved='7.8::SSL.Constants.PROTOCOL_minor'>Constants.PROTOCOL_minor</ref>.</p>   </text></group></doc>   <method name='create'>   <arguments><argument name='is_server'><type><int/></type></argument><argument name='ctx'><type><or><void/><object resolved='7.8::SSL.context'>SSL.context</object></or></type></argument><argument name='min_version'><type><or><void/><object resolved='7.8::SSL.Constants.ProtocolVersion'>ProtocolVersion</object></or></type></argument><argument name='max_version'><type><or><void/><object resolved='7.8::SSL.Constants.ProtocolVersion'>ProtocolVersion</object></or></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   <docgroup homogen-name='handle_handshake' homogen-type='method'><doc><text><p>Do handshake processing. Type is one of HANDSHAKE_*, data is the    contents of the packet, and raw is the raw packet received (needed
autodoc.git/autodoc.xml:1887:   <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='predef::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='7.8::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/autodoc.xml:20968:   <method name='fold'>   <arguments><argument name='futures'><type><array><valuetype><object resolved='predef::Concurrent.Future'>Future</object></valuetype></array></type></argument><argument name='initial'><type><mixed/></type></argument><argument name='fun'><type><function><argtype><mixed/></argtype><argtype><mixed/></argtype><argtype><varargs><mixed/></varargs></argtype><returntype><mixed/></returntype></function></type></argument><argument name='extra'><type><varargs><mixed/></varargs></type></argument></arguments>   <returntype><object resolved='predef::Concurrent.Future'>Future</object></returntype>   </method>   </docgroup>   <docgroup><doc><text><p>Global failure callback, called when a promise without failure    callback fails. This is useful to log exceptions, so they are not    just silently caught and ignored.</p>   </text></doc>   <method name='on_failure'> - <arguments><argument name='f'><type><function><argtype><mixed/></argtype><argtype><varargs><mixed/></varargs></argtype><returntype><void/></returntype></function></type></argument></arguments> + <arguments><argument name='f'><type><function><argtype><mixed/></argtype><returntype><void/></returntype></function></type></argument></arguments>   <returntype><void/></returntype>   </method> - <variable name='global_on_failure'><modifiers><protected/></modifiers><type><function><argtype><mixed/></argtype><argtype><varargs><mixed/></varargs></argtype><returntype><void/></returntype></function></type></variable> + <variable name='global_on_failure'><modifiers><protected/></modifiers><type><function><argtype><mixed/></argtype><returntype><void/></returntype></function></type></variable>   </docgroup>   <docgroup homogen-name='' homogen-type='import'>   <import name=''><classname resolved='predef::'>predef::</classname></import>   </docgroup>   <docgroup homogen-name='race' homogen-type='method'><doc><text><p>JavaScript Promise API equivalent of <ref resolved='predef::Concurrent.first_completed'>first_completed()</ref>.</p>   </text><group><seealso/><text><p><ref resolved='predef::Concurrent.first_completed'>first_completed()</ref>    <url>https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Promise</url></p>   </text></group></doc>   <method name='race'><modifiers><variant/><local/></modifiers>   <arguments><argument name='futures'><type><array><valuetype><object resolved='predef::Concurrent.Future'>Future</object></valuetype></array></type></argument></arguments>
autodoc.git/autodoc.xml:90051:   <returntype><array><valuetype><object resolved='predef::Gmp.mpz'>Gmp.mpz</object></valuetype></array></returntype>   </method>   </docgroup>   <docgroup homogen-name='raw_verify' homogen-type='method'><doc><text><p>Verify the signature <ref resolved='predef::Nettle.ECC_Curve.ECDSA.raw_verify.r'>r</ref>, <ref resolved='predef::Nettle.ECC_Curve.ECDSA.raw_verify.s'>s</ref> against the message digest <ref resolved='predef::Nettle.ECC_Curve.ECDSA.raw_verify.digest'>digest</ref>.</p>   </text></doc>   <method name='raw_verify'>   <arguments><argument name='digest'><type><string><min>0</min><max>255</max></string></type></argument><argument name='r'><type><object resolved='predef::Gmp.mpz'>Gmp.mpz</object></type></argument><argument name='s'><type><object resolved='predef::Gmp.mpz'>Gmp.mpz</object></type></argument></arguments>   <returntype><int><min>0</min><max>1</max></int></returntype>   </method>   </docgroup> - <docgroup homogen-name='set_private_key' homogen-type='method'><doc><text><p>Set the private key (and corresponding private key).</p> + <docgroup homogen-name='set_private_key' homogen-type='method'><doc><text><p>Set the private key (and corresponding public key).</p>   </text><group><note/><text><p>Throws errors if the key isn't valid for the curve.</p>   </text></group></doc>   <method name='set_private_key'>   <arguments><argument name='k'><type><or><object resolved='predef::Gmp.mpz'>Gmp.mpz</object><int/></or></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   <docgroup homogen-name='set_public_key' homogen-type='method'><doc><text><p>Change to the selected point on the curve as public key.</p>   </text><group><note/><text><p>Throws errors if the point isn't on the curve.</p>   </text></group></doc>
autodoc.git/autodoc.xml:92177:   <variable name='lr_error'><type><int/></type></variable>   </docgroup>   <docgroup homogen-name='make_parser' homogen-type='method'><doc><text><p>Compiles the parser-specification given in the first argument.    Named actions are taken from the object if available, otherwise    left as is.</p>   </text><group><bugs/><text><p>Returns error-code in both GrammarParser.error and    return_value-&gt;lr_error.</p>   </text></group></doc>   <method name='make_parser'>   <arguments><argument name='str'><type><string/></type></argument><argument name='m'><type><or><object resolved='predef::Parser.LR.GrammarParser.make_parser'/><void/></or></type></argument></arguments> - <returntype><object resolved='predef::Parser.LR.Parser'>Parser</object></returntype> + <returntype><object resolved='predef::Parser'>Parser</object></returntype>   </method>   </docgroup>   <docgroup homogen-name='make_parser_from_file' homogen-type='method'><doc><text><p>Compiles the file specified in the first argument into an LR parser.</p>   </text><group><seealso/><text><p><ref resolved='predef::Parser.LR.GrammarParser.make_parser'>make_parser</ref></p>   </text></group></doc>   <method name='make_parser_from_file'>   <arguments><argument name='fname'><type><string/></type></argument><argument name='m'><type><or><object resolved='predef::Parser.LR.GrammarParser.make_parser_from_file'/><void/></or></type></argument></arguments> - <returntype><or><int/><object resolved='predef::Parser.LR.Parser'>Parser</object></or></returntype> + <returntype><or><int/><object resolved='predef::Parser'>Parser</object></or></returntype>   </method>   </docgroup>   </module>   <class name='Parser'>   <doc><text><p>This object implements an LALR(1) parser and compiler.</p>   <p> Normal use of this object would be:</p>   <p> <pre>    set_error_handler    {add_rule, set_priority, set_associativity}*    set_symbol_to_string