update generated docs

parent d0ced053
.. ..
.. NB: This file is machine generated, DO NOT EDIT! .. NB: This file is machine generated, DO NOT EDIT!
.. ..
.. Edit vmod.vcc and run make instead .. Edit ../src/vmod_hoailona.vcc and run make instead
.. ..
.. role:: ref(emphasis) .. role:: ref(emphasis)
============= =============
VMOD hoailona vmod_hoailona
============= =============
---------------------------------------- ----------------------------------------
...@@ -21,7 +21,7 @@ SYNOPSIS ...@@ -21,7 +21,7 @@ SYNOPSIS
.. parsed-literal:: .. parsed-literal::
import hoailona [from "path"] import hoailona [as name] [from "path"]
new xpolicy = hoailona.policy(ENUM type, DURATION ttl, STRING description, BLOB secret, INT start_offset) new xpolicy = hoailona.policy(ENUM type, DURATION ttl, STRING description, BLOB secret, INT start_offset)
...@@ -241,7 +241,7 @@ subroutines, subsequent calls to ``.token()`` and ``.secret()`` in the ...@@ -241,7 +241,7 @@ subroutines, subsequent calls to ``.token()`` and ``.secret()`` in the
same backend transaction are based on the policy that was determined same backend transaction are based on the policy that was determined
by that call. by that call.
.. _vmod_hoailona.policy: .. _hoailona.policy():
new xpolicy = hoailona.policy(ENUM type, DURATION ttl, STRING description, BLOB secret, INT start_offset) new xpolicy = hoailona.policy(ENUM type, DURATION ttl, STRING description, BLOB secret, INT start_offset)
--------------------------------------------------------------------------------------------------------- ---------------------------------------------------------------------------------------------------------
...@@ -309,7 +309,7 @@ Examples:: ...@@ -309,7 +309,7 @@ Examples::
# A policy for "access denied" # A policy for "access denied"
new forbid = hoailona.policy(DENY, description="access denied"); new forbid = hoailona.policy(DENY, description="access denied");
.. _vmod_hoailona.hosts: .. _hoailona.hosts():
new xhosts = hoailona.hosts() new xhosts = hoailona.hosts()
----------------------------- -----------------------------
...@@ -319,7 +319,7 @@ that associates with policies with hostnames, and optionally with ...@@ -319,7 +319,7 @@ that associates with policies with hostnames, and optionally with
path patterns. The constructor has no parameters; the object only path patterns. The constructor has no parameters; the object only
becomes useful by calling the ``.add()`` method. becomes useful by calling the ``.add()`` method.
.. _vmod_hoailona.hosts.add: .. _xhosts.add():
VOID xhosts.add(STRING host, STRING policy, STRING path, STRING description) VOID xhosts.add(STRING host, STRING policy, STRING path, STRING description)
---------------------------------------------------------------------------- ----------------------------------------------------------------------------
...@@ -464,7 +464,7 @@ Examples:: ...@@ -464,7 +464,7 @@ Examples::
h.add("evil.org", "deny", description="no access to evil.org"); h.add("evil.org", "deny", description="no access to evil.org");
} }
.. _vmod_hoailona.hosts.policy: .. _xhosts.policy():
INT xhosts.policy(STRING host=0, STRING path=0) INT xhosts.policy(STRING host=0, STRING path=0)
----------------------------------------------- -----------------------------------------------
...@@ -531,7 +531,7 @@ with parameters. ...@@ -531,7 +531,7 @@ with parameters.
Calling ``.policy()`` with only one of the ``host`` and ``path`` Calling ``.policy()`` with only one of the ``host`` and ``path``
parameters empty is an error. parameters empty is an error.
.. _vmod_hoailona.hosts.token: .. _xhosts.token():
STRING xhosts.token(STRING acl, DURATION ttl, STRING data) STRING xhosts.token(STRING acl, DURATION ttl, STRING data)
---------------------------------------------------------- ----------------------------------------------------------
...@@ -592,7 +592,7 @@ Examples:: ...@@ -592,7 +592,7 @@ Examples::
# needed for SecureHD authorization. # needed for SecureHD authorization.
} }
.. _vmod_hoailona.hosts.secret: .. _xhosts.secret():
BLOB xhosts.secret() BLOB xhosts.secret()
-------------------- --------------------
...@@ -635,7 +635,7 @@ Examples:: ...@@ -635,7 +635,7 @@ Examples::
} }
} }
.. _vmod_hoailona.hosts.explain: .. _xhosts.explain():
STRING xhosts.explain() STRING xhosts.explain()
----------------------- -----------------------
...@@ -669,7 +669,7 @@ Example:: ...@@ -669,7 +669,7 @@ Example::
std.log("Policy determination: " + config.explain()); std.log("Policy determination: " + config.explain());
} }
.. _vmod_hoailona.version: .. _hoailona.version():
STRING version() STRING version()
---------------- ----------------
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment