diff options
author | Jeffrey Walton <noloader@gmail.com> | 2020-12-07 23:35:10 -0500 |
---|---|---|
committer | Jeffrey Walton <noloader@gmail.com> | 2020-12-07 23:35:10 -0500 |
commit | ac6987f3aee8fedd52a08f8d6e9b7d5ad28559bb (patch) | |
tree | a0f63ebf397db67a1d8f7e41f2e4e89d03a57a4f /mersenne.h | |
parent | 4d2b58c8fe92e7ce5007d2f15f046d33f37eedc2 (diff) | |
download | cryptopp-git-ac6987f3aee8fedd52a08f8d6e9b7d5ad28559bb.tar.gz |
Use \return and \throw consitently in the docs
Diffstat (limited to 'mersenne.h')
-rw-r--r-- | mersenne.h | 4 |
1 files changed, 2 insertions, 2 deletions
@@ -102,7 +102,7 @@ public: }
/// \brief Generate a random 32-bit word in the range min to max, inclusive
- /// \returns random 32-bit word in the range min to max, inclusive
+ /// \return random 32-bit word in the range min to max, inclusive
/// \details If the 32-bit candidate is not within the range, then it is discarded
/// and a new candidate is used.
word32 GenerateWord32(word32 min=0, word32 max=0xffffffffL)
@@ -146,7 +146,7 @@ protected: }
/// \brief Returns the next 32-bit word from the state array
- /// \returns the next 32-bit word from the state array
+ /// \return the next 32-bit word from the state array
/// \details fetches the next word frm the state array, performs bit operations on
/// it, and then returns the value to the caller.
word32 NextMersenneWord()
|