autodoc.git / traditional.xml

version» Context lines:

autodoc.git/traditional.xml:1:   <?xml version='1.0' encoding='utf-8'?> - <manual time-stamp='2018-12-01' version='Pike v8.1.13'> + <manual time-stamp='2018-12-03' version='Pike v8.1.13'>    <dir name='./traditional_manual'>    <file name='./traditional_manual/index.html'>    <chapter title='Table of Contents' unnumbered='1'>    <dl><dt><url href='index.html'>Table of Contents</url></dt>   <dt><url href='chapter_1.html'>1. Introduction</url></dt>   <dd><url href='chapter_1.html#1'>1.1. Overview</url></dd>   <dd><url href='chapter_1.html#2'>1.2. The history of Pike</url></dd>   <dd><url href='chapter_1.html#3'>1.3. A comparison with other languages</url></dd>   <dd><url href='chapter_1.html#4'>1.4. What is Pike</url></dd>   <dd><url href='chapter_1.html#5'>1.5. Pike License</url></dd>
autodoc.git/traditional.xml:4883:   </text></group><group><note/><text><p>The function <ref resolved='predef::hash'>predef::hash</ref> does not return hash values that    are compatible with this one.</p>   </text></group><group><note/><text><p>It's assumed that this function is side-effect free.</p>   </text></group><group><seealso/><text><p><ref resolved='lfun::`=='>lfun::`==</ref>, <ref resolved='predef::hash_value'>predef::hash_value()</ref></p>   </text></group></doc>   <method name='__hash'>   <arguments/>   <returntype><int/></returntype>   </method>   </docgroup> + <docgroup homogen-name='_annotations' homogen-type='method'><doc><text><p>Called by <ref>annotations()</ref></p> + </text><group><param name='context'/><text><p>Inherit in the current object to return the annotations for. +  If <expr>UNDEFINED</expr> or left out, <expr>this_program::this</expr> +  should be used (ie start at the current context and ignore +  any overloaded symbols).</p> + </text></group><group><param name='access'/><text><p>Access permission override. One of the following:</p> + <int><group><value>0</value><value>UNDEFINED</value><text><p>See only public symbols.</p> + </text></group><group><value>1</value><text><p>See protected symbols as well.</p> + </text></group></int> + </text></group><group><param name='recursive'/><text><p>Include nested annotations from the inherits.</p> + </text></group><group><seealso/><text><p><ref>annotations()</ref></p> + </text></group></doc> + <method name='_annotations'> + <arguments><argument name='context'><type><or><object resolved='lfun::_annotations'/><void/></or></type></argument><argument name='access'><type><or><int/><void/></or></type></argument><argument name='recursive'><type><or><int><min>0</min><max>1</max></int><void/></or></type></argument></arguments> + <returntype><array/></returntype> + </method> + </docgroup>   <docgroup homogen-name='_deserialize' homogen-type='method'><doc><text><p>Dispatch function for <ref>Serialization.deserialize()</ref>.</p>   </text><group><param name='o'/><text><p>Object to serialize. Always a context of the current object.</p>   </text></group><group><param name='deserializer'/><text><p>Function to be called once for every variable    to serialize.</p>   <p> The <ref resolved='lfun::_deserialize.deserializer'>deserializer</ref> function expects to be called with three arguments:</p>   <dl><group><item/><text><p><tt>setter</tt> - Function that sets the symbol value.</p>   </text></group><group><item/><text><p><tt>symbol</tt> - The symbol name.</p>   </text></group><group><item/><text><p><tt>symbol_type</tt> - The type of the symbol.</p>   </text></group></dl>   </text></group><group><note/><text><p>A default implementation of <ref resolved='lfun::_serialize'>lfun::_serialize()</ref> and
autodoc.git/traditional.xml:5160:    robust and not make any assumptions about its own internal    state, at least not when <ref resolved='lfun::_sprintf.conversion_type'>conversion_type</ref> is <expr>'O'</expr>.</p>   </text></group><group><note/><text><p>It's assumed that this function is side-effect free.</p>   </text></group><group><seealso/><text><p><ref resolved='predef::sprintf'>predef::sprintf()</ref></p>   </text></group></doc>   <method name='_sprintf'>   <arguments><argument name='conversion_type'><type><int/></type></argument><argument name='params'><type><or><mapping><indextype><string/></indextype><valuetype><int/></valuetype></mapping><void/></or></type></argument></arguments>   <returntype><string/></returntype>   </method>   </docgroup> + <docgroup homogen-name='_sqrt' homogen-type='method'><doc><text><p>Called by <ref>sqrt()</ref>.</p> + </text><group><seealso/><text><p><ref>sqrt()</ref></p> + </text></group></doc> + <method name='_sqrt'> + <arguments/> + <returntype><mixed/></returntype> + </method> + </docgroup>   <docgroup homogen-name='_sqrt' homogen-type='method'><doc><text><p>Called by sqrt when the square root of an object is requested.</p>   </text><group><note/><text><p>_sqrt is not a real lfun, so it must not be defined as static.</p>   </text></group><group><seealso/><text><p><ref resolved='predef::sqrt'>predef::sqrt()</ref></p>   </text></group></doc>   <method name='_sqrt'>   <arguments/>   <returntype><mixed/></returntype>   </method>   </docgroup>   <docgroup homogen-name='_types' homogen-type='method'><doc><text><p>List types callback.</p>
autodoc.git/traditional.xml:5241:   </docgroup>   <docgroup homogen-name='`*' homogen-type='method'><doc><text><p>Left side multiplication/repetition/implosion callback.</p>   </text><group><note/><text><p>It's assumed that this function is side-effect free.</p>   </text></group><group><seealso/><text><p><ref resolved='lfun::``*'>lfun::``*()</ref>, <ref resolved='predef::`*'>predef::`*()</ref></p>   </text></group></doc>   <method name='`*'>   <arguments><argument name='args'><type><varargs><zero/></varargs></type></argument></arguments>   <returntype><mixed/></returntype>   </method>   </docgroup> + <docgroup homogen-name='`**' homogen-type='method'><doc><text><p>Called by <ref resolved='predef::`**'>predef::`**()</ref>.</p> + </text><group><seealso/><text><p><ref resolved='predef::`**'>predef::`**()</ref>, <ref resolved='lfun::``**'>lfun::``**()</ref></p> + </text></group></doc> + <method name='`**'> + <arguments><argument name='exp'><type><or><int/><float/><object resolved='lfun::`**'/></or></type></argument></arguments> + <returntype><or><object resolved='lfun::`**'/><int/><float/></or></returntype> + </method> + </docgroup>   <docgroup homogen-name='`+' homogen-type='method'><doc><text><p>Left side addition/concatenation callback.</p>   <p> This is used by <ref resolved='predef::`+'>predef::`+</ref>. It's called with any arguments    that follow this object in the argument list of the call to    <ref resolved='predef::`+'>predef::`+</ref>. The returned value should be a new instance that    represents the addition/concatenation between this object and    the arguments in the order they are given.</p>   </text><group><note/><text><p>It's assumed that this function is side-effect free.</p>   </text></group><group><seealso/><text><p><ref resolved='lfun::``+'>lfun::``+()</ref>, <ref resolved='lfun::`+='>lfun::`+=()</ref>, <ref resolved='predef::`+'>predef::`+()</ref></p>   </text></group></doc>   <method name='`+'>
autodoc.git/traditional.xml:5472:   </docgroup>   <docgroup homogen-name='``*' homogen-type='method'><doc><text><p>Right side multiplication/repetition/implosion callback.</p>   </text><group><note/><text><p>It's assumed that this function is side-effect free.</p>   </text></group><group><seealso/><text><p><ref resolved='lfun::`*'>lfun::`*()</ref>, <ref resolved='predef::`*'>predef::`*()</ref></p>   </text></group></doc>   <method name='``*'>   <arguments><argument name='args'><type><varargs><zero/></varargs></type></argument></arguments>   <returntype><mixed/></returntype>   </method>   </docgroup> + <docgroup homogen-name='``**' homogen-type='method'><doc><text><p>Called by <ref resolved='predef::`**'>predef::`**()</ref>.</p> + </text><group><seealso/><text><p><ref resolved='predef::`**'>predef::`**()</ref>, <ref resolved='lfun::`**'>lfun::`**()</ref></p> + </text></group></doc> + <method name='``**'> + <arguments><argument name='base'><type><or><int/><float/><object resolved='lfun::``**'/></or></type></argument></arguments> + <returntype><or><object resolved='lfun::``**'/><int/><float/></or></returntype> + </method> + </docgroup>   <docgroup homogen-name='``+' homogen-type='method'><doc><text><p>Right side addition/concatenation callback.</p>   <p> This is used by <ref resolved='predef::`+'>predef::`+</ref>. It's called with any arguments    that precede this object in the argument list of the call to    <ref resolved='predef::`+'>predef::`+</ref>. The returned value should be a new instance that    represents the addition/concatenation between the arguments in    the order they are given and this object.</p>   </text><group><note/><text><p>It's assumed that this function is side-effect free.</p>   </text></group><group><seealso/><text><p><ref resolved='lfun::`+'>lfun::`+()</ref>, <ref resolved='predef::`+'>predef::`+()</ref></p>   </text></group></doc>   <method name='``+'>
autodoc.git/traditional.xml:88514:   <method name='allocate'>   <arguments><argument name='size'><type><int/></type></argument></arguments>   <returntype><array/></returntype>   </method>   <method name='allocate'>   <arguments><argument name='size'><type><int/></type></argument><argument name='init'><type><mixed/></type></argument></arguments>   <returntype><array/></returntype>   </method>   </docgroup>   <docgroup homogen-name='annotations' homogen-type='method'><doc><text><p>Return an array with the annotations for all symbols in <ref resolved='predef::annotations.x'>x</ref>.</p> - </text><group><param name='x'/><text><mixed><group><type><object resolved='predef::annotations'/></type><text><p>For objects which define <ref>lfun::_annotations()</ref> that return value + </text><group><param name='x'/><text><mixed><group><type><object resolved='predef::annotations'/></type><text><p>For objects which define <ref resolved='lfun::_annotations'>lfun::_annotations()</ref> that return value    is used.</p>   <p> For other objects an array with annotations for all non-protected    symbols is returned.</p>   </text></group><group><type><program/></type><text><p>Returns an array with annotations for all non-protected symbols.</p>   </text></group></mixed>   </text></group><group><param name='recurse'/><text><p>Include annotations recursively added via inherits.</p>   </text></group><group><note/><text><p>This function was added in Pike 8.1.</p>   </text></group><group><seealso/><text><p><ref resolved='predef::indices'>indices()</ref>, <ref resolved='predef::values'>values()</ref>, <ref resolved='predef::types'>types()</ref></p>   </text></group></doc>   <method name='annotations'>