Commit 5adbf278 authored by Geoff Simmons's avatar Geoff Simmons

Updates in README due to updated formatting style.

parent d9cbec68
......@@ -21,7 +21,7 @@ SYNOPSIS
.. parsed-literal::
import blobdigest [from "path"]
import blobdigest [as name] [from "path"]
new xdigest = blobdigest.digest(ENUM hash, BLOB init, ENUM scope)
......@@ -220,7 +220,7 @@ values:
* ``SHA3_384``
* ``SHA3_512``
.. _vmod_blobdigest.digest:
.. _blobdigest.digest():
new xdigest = blobdigest.digest(ENUM hash, BLOB init, ENUM scope)
-----------------------------------------------------------------
......@@ -263,7 +263,7 @@ Example::
new sha512 = blobdigest.digest(SHA512, foo.get());
}
.. _vmod_blobdigest.digest.update:
.. _xdigest.update():
BOOL xdigest.update(BLOB)
-------------------------
......@@ -319,7 +319,7 @@ Example::
call do_backend_error;
}
.. _vmod_blobdigest.digest.final:
.. _xdigest.final():
BLOB xdigest.final()
--------------------
......@@ -403,7 +403,7 @@ Example::
# Baz-Hash-Base64: base64-encoded SHA3_256 hash of "baz"
# Baz-Hash-Hex: hex-encoded SHA3_256 hash of "bar"
.. _vmod_blobdigest.hash:
.. _blobdigest.hash():
BLOB hash(ENUM hash, BLOB msg)
------------------------------
......@@ -429,7 +429,7 @@ Example::
blobdigest.hash(SHA256,
blob.decode(decoding=BASE64, encoded="Zm9v"));
.. _vmod_blobdigest.hmac:
.. _blobdigest.hmac():
new xhmac = blobdigest.hmac(ENUM hash, BLOB key)
------------------------------------------------
......@@ -456,7 +456,7 @@ Example::
new hmac = blobdigest.hmac(SHA256, key.get());
}
.. _vmod_blobdigest.hmac.hmac:
.. _xhmac.hmac():
BLOB xhmac.hmac(BLOB msg)
-------------------------
......@@ -478,14 +478,14 @@ Example::
return(synth(401));
}
.. _vmod_blobdigest.hmac.hmac_bench:
.. _xhmac.hmac_bench():
DURATION xhmac.hmac_bench(INT n, BLOB msg)
------------------------------------------
Run `n` rounds of ``.hmac`` and return the net total duration.
.. _vmod_blobdigest.hmacf:
.. _blobdigest.hmacf():
BLOB hmacf(ENUM hash, BLOB key, BLOB msg)
-----------------------------------------
......@@ -524,7 +524,7 @@ Example::
blob.decode(encoded=
req.http.Msg)));
.. _vmod_blobdigest.version:
.. _blobdigest.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