autodoc.git / autodoc.xml

version» Context lines:

autodoc.git/autodoc.xml:98172:   </docgroup>   </class>   <class name='Lexer'>   <doc><text><p>Block-level lexer (parses paragraphs, lists, tables, etc).</p>   </text></doc>   <docgroup homogen-name='lex' homogen-type='method'><doc><text><p>Main lexing entry point. Subclass Lexer and override this to add    post-processing or other changes.</p>   </text></doc>   <method name='lex'>   <arguments><argument name='src'><type><string/></type></argument></arguments> - <returntype><object resolved='predef::object_program'>object_program</object></returntype> + <returntype><object resolved='predef::Parser.Markdown.Lexer'>this_program</object></returntype>   </method>   </docgroup>   <docgroup homogen-name='links' homogen-type='variable'><doc><group><note/><text><p>Read only</p>   </text></group></doc>   <variable name='links'><type><mapping/></type></variable>   </docgroup>   <docgroup homogen-name='tokens' homogen-type='variable'><doc><group><note/><text><p>Read only</p>   </text></group></doc>   <variable name='tokens'><type><array><valuetype><mapping/></valuetype></array></type></variable>   </docgroup>
autodoc.git/autodoc.xml:111609:   </docgroup>   <docgroup homogen-name='permessagedeflate' homogen-type='method'><doc><text><p>Returns an extension factory which implements the <expr>permessage-deflate</expr> WebSocket extension.    It uses the default options from <ref resolved='predef::Protocols.WebSocket.deflate_default_options'>deflate_default_options</ref>. Due to how the    <expr>permessage-deflate</expr> extension works, defragmented frames will be recombined    automatically.</p>   </text><group><note/><text><p>If the <expr>permessage-deflate</expr> extension is not being used, it falls back to use    <ref resolved='predef::Protocols.WebSocket.defragment'>defragment</ref>.</p>   </text></group></doc>   <method name='permessagedeflate'>   <arguments><argument name='default_options'><type><or><void/><mapping/></or></type></argument></arguments> - <returntype><object resolved='predef::Protocols.WebSocket.permessagedeflate'/></returntype> + <returntype><object resolved='predef::Protocols.WebSocket.extension_factory'>extension_factory</object></returntype>   </method>   </docgroup>   <enum name='CLOSE_STATUS'>   <doc><text><p>WebSocket close status codes, as explained in the WebSocket protocol    specification.</p>   </text></doc>   <docgroup homogen-name='CLOSE_BAD_DATA' homogen-type='constant'>   <constant name='CLOSE_BAD_DATA'/>   </docgroup>   <docgroup homogen-name='CLOSE_BAD_TYPE' homogen-type='constant'>
autodoc.git/autodoc.xml:111716:   </text></doc>   <method name='fail'>   <arguments><argument name='reason'><type><or><void/><object resolved='predef::Protocols.WebSocket.CLOSE_STATUS'>CLOSE_STATUS</object></or></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   <docgroup homogen-name='http_read' homogen-type='method'><doc><text><p>Read HTTP response from remote endpoint and handle connection    upgrade.</p>   </text></doc>   <method name='http_read'><modifiers><protected/></modifiers> - <arguments><argument name='_id'><type><mixed/></type></argument><argument name='data'><type><string/></type></argument><argument name='hp'><type><object resolved='predef::Protocols.WebSocket.Connection.http_read'/></type></argument><argument name='extensions'><type><array><valuetype><object resolved='predef::Protocols.WebSocket.extension_factory'>extension_factory</object></valuetype></array></type></argument><argument name='rext'><type><mapping/></type></argument></arguments> + <arguments><argument name='_id'><type><mixed/></type></argument><argument name='data'><type><string/></type></argument><argument name='hp'><type><object resolved='predef::Protocols.WebSocket.Connection.http_read'/></type></argument><argument name='extensions'><type><array><valuetype><or><object resolved='predef::Protocols.WebSocket.Connection.http_read'/><object resolved='predef::Protocols.WebSocket.extension_factory'>extension_factory</object></or></valuetype></array></type></argument><argument name='rext'><type><mapping/></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   <docgroup homogen-name='masking' homogen-type='variable'><doc><text><p>If true, all outgoing frames are masked.</p>   </text></doc>   <variable name='masking'><type><int><min>0</min><max>1</max></int></type></variable>   </docgroup>   <docgroup homogen-name='onclose' homogen-type='variable'><doc><text><p>This callback will be called once the WebSocket has been closed.    No more frames can be sent or will be received after the close    event has been triggered.