From 77cd5c69d07bc9dc8a4cb1c30f8cba7c13878c4b Mon Sep 17 00:00:00 2001 From: Jeffrey Walton Date: Fri, 6 Jul 2018 03:18:45 -0400 Subject: [PATCH] Update documentation --- cryptlib.h | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/cryptlib.h b/cryptlib.h index 49ee654f..2a433582 100644 --- a/cryptlib.h +++ b/cryptlib.h @@ -668,9 +668,12 @@ public: {SetKeyWithIV(key, length, iv, IVSize());} /// \brief Secure IVs requirements as enumerated values. - /// \details Provides secure IV requirements as a monotonically increasing enumerated values. Requirements can be - /// compared using less than (<) and greater than (>). For example, UNIQUE_IV < RANDOM_IV - /// and UNPREDICTABLE_RANDOM_IV > RANDOM_IV. + /// \details Provides secure IV requirements as a monotonically increasing enumerated values. + /// Requirements can be compared using less than (<) and greater than (>). For example, + /// UNIQUE_IV < RANDOM_IV and UNPREDICTABLE_RANDOM_IV > RANDOM_IV. + /// \details Objects that use SimpleKeyingInterface do not support an optional IV. That is, + /// an IV must be present or it must be absent. If you wish to support an optional IV then + /// provide two classes - one with an IV and one without an IV. /// \sa IsResynchronizable(), CanUseRandomIVs(), CanUsePredictableIVs(), CanUseStructuredIVs() enum IV_Requirement { /// \brief The IV must be unique