diff options
| author | René Korthaus <[email protected]> | 2016-10-18 16:38:50 +0200 |
|---|---|---|
| committer | René Korthaus <[email protected]> | 2016-10-19 09:13:45 +0200 |
| commit | da2e26b15f7f6882768f1cb7e8a5be1b1893bf8a (patch) | |
| tree | b83ce7adb7b8837981c210662675941febc645c4 /src/lib/rng | |
| parent | 99d71e5693f45c2b34528158ad8d8b641bcc87e3 (diff) | |
Fix doxygen warnings [ci skip]
Diffstat (limited to 'src/lib/rng')
| -rw-r--r-- | src/lib/rng/hmac_rng/hmac_rng.h | 4 | ||||
| -rw-r--r-- | src/lib/rng/rng.h | 2 | ||||
| -rw-r--r-- | src/lib/rng/stateful_rng/stateful_rng.h | 2 |
3 files changed, 6 insertions, 2 deletions
diff --git a/src/lib/rng/hmac_rng/hmac_rng.h b/src/lib/rng/hmac_rng/hmac_rng.h index d6e9b4896..e4cb4a2bf 100644 --- a/src/lib/rng/hmac_rng/hmac_rng.h +++ b/src/lib/rng/hmac_rng/hmac_rng.h @@ -28,6 +28,7 @@ class BOTAN_DLL HMAC_RNG final : public Stateful_RNG public: /** * Initialize an HMAC_RNG instance with the given MAC as PRF (normally HMAC) + * @param prf MAC to use as a PRF * @param underlying_rng is a reference to some RNG which will be used * to perform the periodic reseeding. * @param entropy_sources will be polled to perform reseeding periodically @@ -41,6 +42,7 @@ class BOTAN_DLL HMAC_RNG final : public Stateful_RNG /** * Initialize an HMAC_RNG instance with the given MAC as PRF (normally HMAC) + * @param prf MAC to use as a PRF * @param underlying_rng is a reference to some RNG which will be used * to perform the periodic reseeding. * @param reseed_interval specifies a limit of how many times @@ -52,6 +54,7 @@ class BOTAN_DLL HMAC_RNG final : public Stateful_RNG /* * Initialize an HMAC_RNG instance with the given MAC as PRF (normally HMAC) + * @param prf MAC to use as a PRF * @param entropy_sources will be polled to perform reseeding periodically * @param reseed_interval specifies a limit of how many times * the RNG will be called before automatic reseeding is performed. @@ -63,6 +66,7 @@ class BOTAN_DLL HMAC_RNG final : public Stateful_RNG /** * Initialize an HMAC_RNG instance with the given MAC as PRF (normally HMAC) * Automatic reseeding is disabled completely. + * @param prf MAC to use as a PRF */ HMAC_RNG(std::unique_ptr<MessageAuthenticationCode> prf); diff --git a/src/lib/rng/rng.h b/src/lib/rng/rng.h index 36a423eca..879c1acb7 100644 --- a/src/lib/rng/rng.h +++ b/src/lib/rng/rng.h @@ -49,7 +49,7 @@ class BOTAN_DLL RandomNumberGenerator * A few RNG types do not accept any externally provided input, * in which case this function is a no-op. * - * @param inputs a byte array containg the entropy to be added + * @param input a byte array containg the entropy to be added * @param length the length of the byte array in */ virtual void add_entropy(const byte input[], size_t length) = 0; diff --git a/src/lib/rng/stateful_rng/stateful_rng.h b/src/lib/rng/stateful_rng/stateful_rng.h index 4eed85d0d..e2b45f8fa 100644 --- a/src/lib/rng/stateful_rng/stateful_rng.h +++ b/src/lib/rng/stateful_rng/stateful_rng.h @@ -41,7 +41,7 @@ class BOTAN_DLL Stateful_RNG : public RandomNumberGenerator {} /** - * @param underlying_rng is a reference to some RNG which will be used + * @param rng is a reference to some RNG which will be used * to perform the periodic reseeding * @param reseed_interval specifies a limit of how many times * the RNG will be called before automatic reseeding is performed |