autodoc.git / modref.xml

autodoc.git/modref.xml:1:   <?xml version='1.0' encoding='utf-8'?> - <manual time-stamp='2019-02-27' version='Pike v8.0.755'> + <manual time-stamp='2019-02-28' version='Pike v8.0.757'>    <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:2392:   </docgroup>   </class>   <class name='DES3'>   <docgroup homogen-name='CBC' homogen-type='inherit'>   <inherit name='CBC'><classname resolved='predef::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='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> +  <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>   </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/modref.xml:3176:   <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/modref.xml:21182:   <docgroup homogen-name='flat_map' homogen-type='method'><doc><text><p>This is an alias for <ref resolved='predef::Concurrent.Future.map_with'>map_with()</ref>.</p>   </text><group><seealso/><text><p><ref resolved='predef::Concurrent.Future.map_with'>map_with()</ref></p>   </text></group></doc>   <method name='flat_map'><modifiers><local/></modifiers>   <arguments><argument name='fun'><type><function><argtype><mixed/></argtype><argtype><varargs><mixed/></varargs></argtype><returntype><object resolved='predef::Concurrent.Future'>this_program</object></returntype></function></type></argument><argument name='extra'><type><varargs><mixed/></varargs></type></argument></arguments>   <returntype><object resolved='predef::Concurrent.Future'>this_program</object></returntype>   </method>   </docgroup>   <docgroup homogen-name='get' homogen-type='method'><doc><text><p>Wait for fulfillment and return the value.</p>   </text><group><throws/><text><p>Throws on rejection.</p> + </text></group><group><seealso/><text><p><ref resolved='predef::Concurrent.Future.wait'>wait()</ref></p>   </text></group></doc>   <method name='get'>   <arguments/>   <returntype><mixed/></returntype>   </method>   </docgroup>   <docgroup homogen-name='get_backend' homogen-type='method'><doc><text><p>Get the backend (if any) used to call any callbacks.</p>   <p> This returns the value set by <ref resolved='predef::Concurrent.Future.set_backend'>set_backend()</ref>.</p>   </text><group><seealso/><text><p><ref resolved='predef::Concurrent.Future.set_backend'>set_backend()</ref></p>   </text></group></doc>
autodoc.git/modref.xml:21413:    as arguments two and onwards when the callbacks are called.</p>   </text></group><group><returns/><text><p>The new <ref resolved='predef::Concurrent.Future'>Future</ref>.</p>   </text></group><group><note/><text><p>This method is used if your callbacks return a <ref resolved='predef::Concurrent.Future'>Future</ref> again.</p>   </text></group><group><seealso/><text><p><ref resolved='predef::Concurrent.Future.transform'>transform()</ref>, <ref resolved='predef::Concurrent.Future.map_with'>map_with()</ref>, <ref resolved='predef::Concurrent.Future.recover_with'>recover_with</ref></p>   </text></group></doc>   <method name='transform_with'>   <arguments><argument name='success'><type><function><argtype><mixed/></argtype><argtype><varargs><mixed/></varargs></argtype><returntype><object resolved='predef::Concurrent.Future'>this_program</object></returntype></function></type></argument><argument name='failure'><type><or><function><argtype><mixed/></argtype><argtype><varargs><mixed/></varargs></argtype><returntype><object resolved='predef::Concurrent.Future'>this_program</object></returntype></function><void/></or></type></argument><argument name='extra'><type><varargs><mixed/></varargs></type></argument></arguments>   <returntype><object resolved='predef::Concurrent.Future'>this_program</object></returntype>   </method>   </docgroup> + <docgroup homogen-name='wait' homogen-type='method'><doc><text><p>Wait for fulfillment.</p> + </text><group><seealso/><text><p><ref resolved='predef::Concurrent.Future.get'>get()</ref></p> + </text></group></doc> + <method name='wait'> + <arguments/> + <returntype><object resolved='predef::Concurrent.Future'>this_program</object></returntype> + </method> + </docgroup>   <docgroup homogen-name='zip' homogen-type='method'><doc><group><param name='others'/><text><p>The other futures (results) you want to append.</p>   </text></group><group><returns/><text><p>A new <ref resolved='predef::Concurrent.Future'>Future</ref> that will be fulfilled with an    array of the fulfilled result of this object followed    by the fulfilled results of other futures.</p>   </text></group><group><seealso/><text><p><ref resolved='predef::Concurrent.results'>results()</ref></p>   </text></group></doc>   <method name='zip'>   <arguments><argument name='others'><type><array><valuetype><object resolved='predef::Concurrent.Future'>this_program</object></valuetype></array></type></argument></arguments>   <returntype><object resolved='predef::Concurrent.Future'>this_program</object></returntype>   </method>
autodoc.git/modref.xml:143253:   </text></doc>   <method name='get_as_image'>   <arguments><argument name='i'><type><object resolved='predef::Tools.PV.PVImage'>PVImage</object></type></argument></arguments>   <returntype><object resolved='predef::Image.Image'>Image.Image</object></returntype>   </method>   </docgroup>   <docgroup homogen-name='' homogen-type='import'>   <import name=''><classname resolved='predef::'>predef::</classname></import>   </docgroup>   <docgroup homogen-name='Window' homogen-type='inherit'> - <inherit name='Window'><classname resolved='predef::GTK2.Window'>GTK.Window</classname></inherit> + <inherit name='Window'><classname resolved='predef::GTK1.Window'>GTK.Window</classname></inherit>   </docgroup>   <docgroup homogen-name='save' homogen-type='method'><doc><text><p>Write the image to a file. If no format is specified, PNG is used.    The alpha combination is done on the image before it's saved.</p>   </text></doc>   <method name='save'>   <arguments><argument name='filename'><type><string/></type></argument><argument name='format'><type><or><string/><void/></or></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   <docgroup homogen-name='scale' homogen-type='method'><doc><text><p>Scale the image before display with the specified factor.</p>