Commit 3482fa99 authored by Nils Goroll's avatar Nils Goroll

streamline doc formatting

- it's implicit that the description is the description and we got
  no other subsections but the example

- the prototype is generated by vmodtool already
parent e6ec6245
Pipeline #14 skipped
......@@ -165,11 +165,10 @@ uppercase, respectively.
$Function BLOB decode(ENUM {IDENTITY, BASE64, BASE64URL, BASE64URLNOPAD,
HEX, URL} decoding="IDENTITY", STRING_LIST encoded)
Description
Returns the BLOB derived from the string ``encoded``
according to the scheme specified by ``decoding``.
Returns the BLOB derived from the string ``encoded`` according to the
scheme specified by ``decoding``.
``decoding`` defaults to IDENTITY
``decoding`` defaults to IDENTITY
Example::
......@@ -186,20 +185,18 @@ $Function BLOB decode_n(INT n,
BASE64URLNOPAD, HEX, URL} decoding="IDENTITY",
STRING_LIST encoded)
Description
Same as ``decode()``, but only decode the first ``n`` characters
of the decoded string. If ``n`` is greater than the length of
the string, then return the same result as ``decode()``.
Same as ``decode()``, but only decode the first ``n`` characters of
the decoded string. If ``n`` is greater than the length of the string,
then return the same result as ``decode()``.
$Function STRING encode(ENUM {IDENTITY, BASE64, BASE64URL, BASE64URLNOPAD,
HEXUC, HEXLC, URLUC, URLLC} encoding="IDENTITY",
BLOB blob)
Description
Returns a string representation of the BLOB ``blob`` as
specifed by ``encoding``.
Returns a string representation of the BLOB ``blob`` as specifed by
``encoding``.
``encoding`` defaults to IDENTITY
``encoding`` defaults to IDENTITY
Example::
......@@ -222,13 +219,12 @@ $Function STRING transcode(ENUM {IDENTITY, BASE64, BASE64URL, BASE64URLNOPAD,
HEXUC, HEXLC, URLUC, URLLC} encoding="IDENTITY",
STRING_LIST encoded)
Description
Translates from one encoding to another, by first decoding
the string ``encoded`` according to the scheme ``decoding``,
and then returning the encoding of the resulting blob
according to the scheme ``encoding``.
Translates from one encoding to another, by first decoding the string
``encoded`` according to the scheme ``decoding``, and then returning
the encoding of the resulting blob according to the scheme
``encoding``.
``decoding`` and ``encoding`` default to IDENTITY
``decoding`` and ``encoding`` default to IDENTITY
Example::
......@@ -254,14 +250,12 @@ $Function STRING transcode_n(INT n,
HEXUC, HEXLC, URLUC, URLLC} encoding="IDENTITY",
STRING_LIST encoded)
Description
Same as ``transcode()``, but only from the first ``n`` characters
of the encoded string.
Same as ``transcode()``, but only from the first ``n`` characters of
the encoded string.
$Function STRING version()
Description
Returns the version string for this VMOD.
Returns the version string for this VMOD.
Example::
......@@ -271,13 +265,8 @@ $Object blob(ENUM {IDENTITY, BASE64, BASE64URL, BASE64URLNOPAD, HEX,
URL} decoding="IDENTITY",
STRING_LIST encoded)
Prototype::
new OBJ = blobcode.blob(ENUM decoding, STRING_LIST encoded)
Description
Creates an object that contains the BLOB derived from the
string ``encoded`` according to the scheme ``decoding``.
Creates an object that contains the BLOB derived from the string
``encoded`` according to the scheme ``decoding``.
Example::
......@@ -291,8 +280,7 @@ Example::
$Method BLOB .get()
Description
Returns the BLOB created by the constructor.
Returns the BLOB created by the constructor.
Example::
......@@ -308,9 +296,8 @@ Example::
$Method STRING .encode(ENUM {IDENTITY, BASE64, BASE64URL, BASE64URLNOPAD, HEXUC,
HEXLC, URLUC, URLLC} encoding="IDENTITY")
Description
Returns an encoding of BLOB created by the constructor,
according to the scheme ``encoding``.
Returns an encoding of BLOB created by the constructor, according to
the scheme ``encoding``.
Example::
......
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