diff options
author | Jack Lloyd <jack@randombit.net> | 2018-07-31 08:48:28 -0400 |
---|---|---|
committer | Jack Lloyd <jack@randombit.net> | 2018-07-31 08:48:28 -0400 |
commit | 857c9f03ed5ff104fef4dc6ed106f7ec0751bbd6 (patch) | |
tree | 56f141280a9035cf897a5da1fa54709238aa2fec /src/lib/rng | |
parent | 66b7c7e1fe6d979fdd9b879b2ec63fe06c1f6fd9 (diff) |
Fix Doxygen comments for AutoSeeded_RNG [ci skip]
Diffstat (limited to 'src/lib/rng')
-rw-r--r-- | src/lib/rng/auto_rng/auto_rng.h | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/src/lib/rng/auto_rng/auto_rng.h b/src/lib/rng/auto_rng/auto_rng.h index 866c56e12..49663cbea 100644 --- a/src/lib/rng/auto_rng/auto_rng.h +++ b/src/lib/rng/auto_rng/auto_rng.h @@ -52,7 +52,9 @@ class BOTAN_PUBLIC_API(2,0) AutoSeeded_RNG final : public RandomNumberGenerator AutoSeeded_RNG(size_t reseed_interval = BOTAN_RNG_DEFAULT_RESEED_INTERVAL); /** - * Uses the BOTAN_AUTO_RNG_DRBG RNG to gather seed material. + * Create an AutoSeeded_RNG which will get seed material from some other + * RNG instance. For example you could provide a reference to the system + * RNG or a hardware RNG. * * @param underlying_rng is a reference to some RNG which will be used * to perform the periodic reseeding @@ -63,7 +65,8 @@ class BOTAN_PUBLIC_API(2,0) AutoSeeded_RNG final : public RandomNumberGenerator size_t reseed_interval = BOTAN_RNG_DEFAULT_RESEED_INTERVAL); /** - * Uses the BOTAN_AUTO_RNG_DRBG RNG to gather seed material. + * Create an AutoSeeded_RNG which will get seed material from a set of + * entropy sources. * * @param entropy_sources will be polled to perform reseeding periodically * @param reseed_interval specifies a limit of how many times @@ -73,7 +76,8 @@ class BOTAN_PUBLIC_API(2,0) AutoSeeded_RNG final : public RandomNumberGenerator size_t reseed_interval = BOTAN_RNG_DEFAULT_RESEED_INTERVAL); /** - * Uses the BOTAN_AUTO_RNG_DRBG RNG to gather seed material. + * Create an AutoSeeded_RNG which will get seed material from both an + * underlying RNG and a set of entropy sources. * * @param underlying_rng is a reference to some RNG which will be used * to perform the periodic reseeding |