aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorlloyd <[email protected]>2013-03-27 18:30:39 +0000
committerlloyd <[email protected]>2013-03-27 18:30:39 +0000
commit8779364036f0f998f3d3939ebde888c03b67a0d0 (patch)
tree6ce560d2742f1a9c361e56ba3c3c60a7a4fc9642 /doc
parentc45eac0c30b6494a75223b389afcca5d7cb2e48d (diff)
Clarify that get_cipher will return AEAD_Filter
Diffstat (limited to 'doc')
-rw-r--r--doc/aead.rst3
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/aead.rst b/doc/aead.rst
index 8f5ff8b94..90304c065 100644
--- a/doc/aead.rst
+++ b/doc/aead.rst
@@ -7,7 +7,8 @@ authenticate additional data that is not included in the ciphertext
(such as a sequence number or header).
The AEAD interface can be used directly, or as part of the filter
-system by using :cpp:class:`AEAD_Filter`.
+system by using :cpp:class:`AEAD_Filter` (which will be returned by
+:cpp:func:`get_cipher` if the named cipher is an AEAD mode).
AEAD modes currently available include GCM, OCB, and EAX.