autodoc.git / onepage.xml

autodoc.git/onepage.xml:2688:   </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='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/onepage.xml:3305:   <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='7.8::SSL.Constants.ProtocolVersion.PROTOCOL_SSL_3_0'>Constants.PROTOCOL_SSL_3_0</ref>.</p> +  Defaults to <ref resolved='predef::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/onepage.xml:3472:   <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/onepage.xml:97789:   </class>   <enum name='SeverityLevel'>   <doc><text><p>Severity level</p>   </text></doc>   <docgroup homogen-type='constant'><constant name='NOTICE'/>   <constant name='WARNING'/>   <constant name='ERROR'/>   </docgroup>   </enum>   </module> + <module name='Markdown'> + <doc><text><p>This is a port of the Javascript Markdown parser +  <url>https://github.com/chjj/marked Marked</url>. The only method needed to +  be used is <ref resolved='predef::Parser.Markdown.parse'>parse()</ref> which will transform Markdown text to HTML.</p> + <p> For a description on Markdown, go to the web page of the inventor of +  Markdown <url>https://daringfireball.net/projects/markdown/</url>.</p> + </text></doc> + <docgroup homogen-name='encode_html' homogen-type='method'><doc><text><p>HTML encode <tt>&lt;&gt;"'</tt>. If <ref resolved='predef::Parser.Markdown.encode_html.enc'>enc</ref> is <tt>true</tt> <tt>&amp;</tt> will also be encoded</p> + </text></doc> + <method name='encode_html'><modifiers><protected/></modifiers> + <arguments><argument name='html'><type><string/></type></argument><argument name='enc'><type><or><void/><object>bool</object></or></type></argument></arguments> + <returntype><string/></returntype> + </method> + </docgroup> + <docgroup homogen-name='' homogen-type='import'> + <import name=''><classname resolved='predef::'>predef::</classname></import> + </docgroup> + <docgroup homogen-name='PCRE' homogen-type='import'> + <import name='PCRE'><classname resolved='predef::Regexp.PCRE'>Regexp.PCRE</classname></import> + </docgroup> + <docgroup homogen-name='parse' homogen-type='method'><doc><text><p>Convert markdown <ref resolved='predef::Parser.Markdown.parse.md'>md</ref> to html</p> + </text><group><param name='options'/><text><mapping><group><member><type><object>bool</object></type><index>"gfm"</index></member><text><p>Enable Github Flavoured Markdown. (true)</p> + </text></group><group><member><type><object>bool</object></type><index>"tables"</index></member><text><p>Enable GFM tables. Requires "gfm" (true)</p> + </text></group><group><member><type><object>bool</object></type><index>"breaks"</index></member><text><p>Enable GFM "breaks". Requires "gfm" (false)</p> + </text></group><group><member><type><object>bool</object></type><index>"pedantic"</index></member><text><p>Conform to obscure parts of markdown.pl as much as possible. +  Don't fix any of the original markdown bugs or poor behavior. (false)</p> + </text></group><group><member><type><object>bool</object></type><index>"sanitize"</index></member><text><p>Sanitize the output. Ignore any HTML that has been input. (false)</p> + </text></group><group><member><type><object>bool</object></type><index>"mangle"</index></member><text><p>Mangle (obfuscate) autolinked email addresses (true)</p> + </text></group><group><member><type><object>bool</object></type><index>"smart_lists"</index></member><text><p>Use smarter list behavior than the original markdown. (true)</p> + </text></group><group><member><type><object>bool</object></type><index>"smartypants"</index></member><text><p>Use "smart" typograhic punctuation for things like quotes and +  dashes. (false)</p> + </text></group><group><member><type><string/></type><index>"header_prefix"</index></member><text><p>Add prefix to ID attributes of header tags (empty)</p> + </text></group><group><member><type><object>bool</object></type><index>"xhtml"</index></member><text><p>Generate self closing XHTML tags (false)</p> + </text></group><group><member><type><object>bool</object></type><index>"newline"</index></member><text><p>Add a newline after tags. If false the output will be +  on one line (well, newlines in text will be kept). (false)</p> + </text></group><group><member><type><object>Renderer</object></type><index>"renderer"</index></member><text><p>Use this renderer to render output. (Renderer)</p> + </text></group></mapping> + </text></group></doc> + <method name='parse'> + <arguments><argument name='md'><type><string/></type></argument><argument name='options'><type><or><void/><mapping/></or></type></argument></arguments> + <returntype><string/></returntype> + </method> + </docgroup> + <docgroup homogen-name='replace1' homogen-type='method'><doc><text><p>Replaces the first occurance of <ref resolved='predef::Parser.Markdown.replace1.from'>from</ref> in <ref resolved='predef::Parser.Markdown.replace1.subject'>subject</ref> to <ref resolved='predef::Parser.Markdown.replace1.to'>to</ref></p> + </text></doc> + <method name='replace1'><modifiers><protected/></modifiers> + <arguments><argument name='subject'><type><string/></type></argument><argument name='from'><type><string/></type></argument><argument name='to'><type><string/></type></argument></arguments> + <returntype><string/></returntype> + </method> + </docgroup> + </module>   <module name='Pike'>   <doc><text><p>This module parses and tokenizes Pike source code.</p>   </text></doc>   <docgroup homogen-name='"C.pmod"' homogen-type='inherit'>   <inherit name='"C.pmod"'><classname resolved='predef::Parser.C'>"C.pmod"</classname></inherit>   </docgroup>   </module>   <module name='Python'>   <docgroup homogen-name='' homogen-type='import'>   <import name=''><classname resolved='predef::'>predef::</classname></import>
autodoc.git/onepage.xml:135715:   <arguments/>   <returntype><string/></returntype>   </method>   </docgroup>   <docgroup homogen-name='' homogen-type='import'>   <import name=''><classname resolved='predef::'>predef::</classname></import>   </docgroup>   </module>   </module>   <module name='Markdown'> - <doc><text><p>This is a port of the Javascript Markdown parser -  <url>https://github.com/chjj/marked Marked</url>. The only method needed to -  be used is <ref resolved='predef::Tools.Markdown.parse'>parse()</ref> which will transform Markdown text to HTML.</p> - <p> For a description on Markdown, go to the web page of the inventor of -  Markdown <url>https://daringfireball.net/projects/markdown/</url>.</p> + <doc><text><p>This is a small stub entrypoint to <ref resolved='predef::Parser.Markdown'>Parser.Markdown</ref> - it is exactly +  equivalent to calling <ref resolved='predef::Parser.Markdown.parse'>Parser.Markdown.parse</ref>().</p>   </text></doc> - <docgroup homogen-name='encode_html' homogen-type='method'><doc><text><p>HTML encode <tt>&lt;&gt;"'</tt>. If <ref resolved='predef::Tools.Markdown.encode_html.enc'>enc</ref> is <tt>true</tt> <tt>&amp;</tt> will also be encoded</p> - </text></doc> - <method name='encode_html'><modifiers><protected/></modifiers> - <arguments><argument name='html'><type><string/></type></argument><argument name='enc'><type><or><void/><object>bool</object></or></type></argument></arguments> - <returntype><string/></returntype> - </method> - </docgroup> +    <docgroup homogen-name='' homogen-type='import'>   <import name=''><classname resolved='predef::'>predef::</classname></import>   </docgroup> - <docgroup homogen-name='PCRE' homogen-type='import'> - <import name='PCRE'><classname resolved='predef::Regexp.PCRE'>Regexp.PCRE</classname></import> - </docgroup> - <docgroup homogen-name='parse' homogen-type='method'><doc><text><p>Convert markdown <ref resolved='predef::Tools.Markdown.parse.md'>md</ref> to html</p> - </text><group><param name='options'/><text><mapping><group><member><type><object>bool</object></type><index>"gfm"</index></member><text><p>Enable Github Flavoured Markdown. (true)</p> - </text></group><group><member><type><object>bool</object></type><index>"tables"</index></member><text><p>Enable GFM tables. Requires "gfm" (true)</p> - </text></group><group><member><type><object>bool</object></type><index>"breaks"</index></member><text><p>Enable GFM "breaks". Requires "gfm" (false)</p> - </text></group><group><member><type><object>bool</object></type><index>"pedantic"</index></member><text><p>Conform to obscure parts of markdown.pl as much as possible. -  Don't fix any of the original markdown bugs or poor behavior. (false)</p> - </text></group><group><member><type><object>bool</object></type><index>"sanitize"</index></member><text><p>Sanitize the output. Ignore any HTML that has been input. (false)</p> - </text></group><group><member><type><object>bool</object></type><index>"mangle"</index></member><text><p>Mangle (obfuscate) autolinked email addresses (true)</p> - </text></group><group><member><type><object>bool</object></type><index>"smart_lists"</index></member><text><p>Use smarter list behavior than the original markdown. (true)</p> - </text></group><group><member><type><object>bool</object></type><index>"smartypants"</index></member><text><p>Use "smart" typograhic punctuation for things like quotes and -  dashes. (false)</p> - </text></group><group><member><type><string/></type><index>"header_prefix"</index></member><text><p>Add prefix to ID attributes of header tags (empty)</p> - </text></group><group><member><type><object>bool</object></type><index>"xhtml"</index></member><text><p>Generate self closing XHTML tags (false)</p> - </text></group><group><member><type><object>bool</object></type><index>"newline"</index></member><text><p>Add a newline after tags. If false the output will be -  on one line (well, newlines in text will be kept). (false)</p> - </text></group><group><member><type><object>Renderer</object></type><index>"renderer"</index></member><text><p>Use this renderer to render output. (Renderer)</p> - </text></group></mapping> - </text></group></doc> - <method name='parse'> - <arguments><argument name='md'><type><string/></type></argument><argument name='options'><type><or><void/><mapping/></or></type></argument></arguments> - <returntype><string/></returntype> - </method> - </docgroup> - <docgroup homogen-name='replace1' homogen-type='method'><doc><text><p>Replaces the first occurance of <ref resolved='predef::Tools.Markdown.replace1.from'>from</ref> in <ref resolved='predef::Tools.Markdown.replace1.subject'>subject</ref> to <ref resolved='predef::Tools.Markdown.replace1.to'>to</ref></p> - </text></doc> - <method name='replace1'><modifiers><protected/></modifiers> - <arguments><argument name='subject'><type><string/></type></argument><argument name='from'><type><string/></type></argument><argument name='to'><type><string/></type></argument></arguments> - <returntype><string/></returntype> - </method> - </docgroup> +    </module>   <module name='MasterHelp'>   <doc><text><p>This module contains usage strings for the <ref>master()-&gt;_main()</ref>.</p>   </text></doc>   <docgroup homogen-name='do_help' homogen-type='method'><doc><text><p>Select a suitable help message.</p>   </text></doc>   <method name='do_help'>   <arguments><argument name='what'><type><or><string/><int/></or></type></argument></arguments>   <returntype><string/></returntype>   </method>