aboutsummaryrefslogtreecommitdiffstats
path: root/doc/aead.rst
diff options
context:
space:
mode:
authorlloyd <[email protected]>2013-04-03 20:15:58 +0000
committerlloyd <[email protected]>2013-04-03 20:15:58 +0000
commit6f4719d43374213a5057ea8689b4c95b5c6ad4ca (patch)
treed75fb5a551983ff14639a6f2868f432cb35a91f3 /doc/aead.rst
parent72e28626c40de83eb37856e252bea647ed523ec4 (diff)
Remove return value of AEAD_Mode::start as it doesn't seem necessary
and is an extra complication for callers. Replace the get_aead in lookup.h returning a Filter with one in aead.h returning AEAD_Mode.
Diffstat (limited to 'doc/aead.rst')
-rw-r--r--doc/aead.rst4
1 files changed, 1 insertions, 3 deletions
diff --git a/doc/aead.rst b/doc/aead.rst
index 9b21108ee..e34b00706 100644
--- a/doc/aead.rst
+++ b/doc/aead.rst
@@ -37,13 +37,11 @@ use a 128-bit block cipher such as AES.
call this function more than once, even across multiple calls
to :cpp:func:`start` and :cpp:func:`finish`.
- .. cpp:function:: secure_vector<byte> start(const byte nonce[], size_t nonce_len)
+ .. cpp:function:: void start(const byte nonce[], size_t nonce_len)
Start processing a message, using *nonce* as the unique
per-message value.
- Returns any initial data that should be emitted (such as a header).
-
.. cpp:function:: void update(secure_vector<byte>& buffer)
Continue processing a message. The *buffer* is an in/out