autodoc.git / onepage.xml

version» Context lines:

autodoc.git/onepage.xml:1:   <?xml version='1.0' encoding='utf-8'?> - <manual time-stamp='2016-12-22' version='Pike v8.0.385'> + <manual time-stamp='2017-01-31' version='Pike v8.0.397'>    <dir name='./onepage'>    <file name='./onepage/manual.html'>    <chapter number='1' title='Control Structures'>      <p>In this chapter all the control structures in Pike will be   explained. Control structures are used to control the flow of the   program execution. Note that functions that make the program pause and   simple function calls are not qualified as control structures.</p>      <section number='1' title='Conditions'>
autodoc.git/onepage.xml:144047:   <docgroup homogen-name='is_val_true' homogen-type='constant'><doc><text><p>Nonzero recognition constant.</p>   </text></doc>   <constant name='is_val_true'><type><int/></type></constant>   </docgroup>   </class>   </module>   <module name='Web'>   <doc><text><p>Modules implementing various web standards.</p>   </text></doc>   <docgroup homogen-name='decode_jwt' homogen-type='method'><doc><text><p>Decode a JSON Web Token (JWT).</p> - </text><group><param name='sign'/><text><p>The public key(s) to validate the jwt against.</p> + </text><group><param name='sign'/><text><p>The asymetric public or MAC key(s) to validate the jwt against.</p>   </text></group><group><param name='jwt'/><text><p>A JWT as eg returned by <ref resolved='predef::Web.encode_jwt'>encode_jwt()</ref>.</p>   </text></group><group><returns/><text><p>Returns <expr>0</expr> (zero) on validation failure (this    includes validation of expiry times).</p>   <p> Returns a mapping of the claims for the token on success.    See <rfc>7519:4</rfc>.</p>   </text></group><group><note/><text><p>The time check of the <expr>"nbf"</expr> value has a hard coded    60 second grace time (as allowed by <rfc>7519:4.1.5</rfc>).</p>   </text></group><group><seealso/><text><p><ref resolved='predef::Web.encode_jwt'>encode_jwt()</ref>, <rfc>7519:4</rfc></p>   </text></group></doc>   <method name='decode_jwt'> - <arguments><argument name='sign'><type><or><object resolved='predef::Crypto.Sign'>Crypto.Sign</object><array><valuetype><object resolved='predef::Crypto.Sign'>Crypto.Sign</object></valuetype></array></or></type></argument><argument name='jwt'><type><string><min>0</min><max>127</max></string></type></argument></arguments> + <arguments><argument name='sign'><type><or><object>Crypto.Sign.State</object><object resolved='predef::Nettle.MAC.State'>Crypto.MAC.State</object><array><valuetype><or><object resolved='predef::Crypto.Sign'>Crypto.Sign</object><object resolved='predef::Nettle.MAC.State'>Crypto.MAC.State</object></or></valuetype></array></or></type></argument><argument name='jwt'><type><string><min>0</min><max>127</max></string></type></argument></arguments>   <returntype><mapping><indextype><string/></indextype><valuetype><or><string/><int/></or></valuetype></mapping></returntype>   </method>   </docgroup>   <docgroup homogen-name='encode_jwt' homogen-type='method'><doc><text><p>Encode a JSON Web Token (JWT).</p> - </text><group><param name='sign'/><text><p>The private key to use for signing the result.</p> + </text><group><param name='sign'/><text><p>The asymetric private or MAC key to use for signing the result.</p>   </text></group><group><param name='claims'/><text><p>The set of claims for the token. See <rfc>7519:4</rfc>.</p>   </text></group><group><returns/><text><p>Returns <expr>0</expr> (zero) on encoding failure (usually    that <ref resolved='predef::Web.encode_jwt.sign'>sign</ref> doesn't support JWS.</p>   <p> Returns a corresponding JWT on success.</p>   </text></group><group><note/><text><p>The claim <expr>"iat"</expr> (<rfc>7519:4.1.6</rfc> is added unconditionally,    and the claim <expr>"jti"</expr> (<rfc>7519:4.1.7</rfc>) is added    if not already present.</p>   </text></group><group><seealso/><text><p><ref resolved='predef::Web.decode_jwt'>decode_jwt()</ref>, <rfc>7519:4</rfc></p>   </text></group></doc>   <method name='encode_jwt'> - <arguments><argument name='sign'><type><object resolved='predef::Crypto.Sign'>Crypto.Sign</object></type></argument><argument name='claims'><type><mapping><indextype><string/></indextype><valuetype><or><string/><int/></or></valuetype></mapping></type></argument></arguments> + <arguments><argument name='sign'><type><or><object>Crypto.Sign.State</object><object resolved='predef::Nettle.MAC.State'>Crypto.MAC.State</object></or></type></argument><argument name='claims'><type><mapping><indextype><string/></indextype><valuetype><or><string/><int/></or></valuetype></mapping></type></argument></arguments>   <returntype><string><min>0</min><max>127</max></string></returntype>   </method>   </docgroup>   <module name='Api'>   <doc><text><p>The <tt>Web.Api</tt> has modules and classes for communicating with various    <tt>(RESTful)</tt> web api's such as <ref resolved='predef::Web.Api.Facebook'>Web.Api.Facebook</ref>,    <ref resolved='predef::Web.Api.Instagram'>Web.Api.Instagram</ref>, <ref resolved='predef::Web.Api.Twitter'>Web.Api.Twitter</ref> etc.</p>   </text></doc>   <docgroup homogen-name='USER_AGENT' homogen-type='constant'><doc><text><p>Default user agent in HTTP calls</p>   </text></doc>