shadps4-emu/ext-cryptopp
1
0
Fork 0
mirror of https://github.com/shadps4-emu/ext-cryptopp.git synced 2024-11-23 09:59:42 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Clear Clang -Wdocumentation warnings

Browse Source
This commit is contained in:
Jeffrey Walton 2020-12-15 03:37:48 -05:00
parent 03c4290bdf
commit 1d29d4c15d
No known key found for this signature in database
GPG Key ID: B36AB348921B1838
3 changed files with 4 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
hrtimer.h
View File

@ -64,7 +64,6 @@ public:
virtual TimerWord TicksPerSecond() =0; virtual TimerWord TicksPerSecond() =0;
/// \brief Start the timer /// \brief Start the timer
/// \return the current timer value
void StartTimer(); void StartTimer();
/// \brief Retrieve the elapsed time /// \brief Retrieve the elapsed time

4
integer.h
View File

@ -705,8 +705,8 @@ public:
/// \param a a constant reference to an Integer /// \param a a constant reference to an Integer
/// \return a reference to a std::ostream reference /// \return a reference to a std::ostream reference
/// \details The output integer responds to std::hex, std::oct, std::hex, std::upper and /// \details The output integer responds to std::hex, std::oct, std::hex, std::upper and
/// std::lower. The output includes the suffix \a \b h (for hex), \a \b . (\a \b dot, for dec) /// std::lower. The output includes the suffix \a h (for hex), \a . (\a dot, for dec)
/// and \a \b o (for octal). There is currently no way to suppress the suffix. /// and \a o (for octal). There is currently no way to suppress the suffix.
/// \details If you want to print an Integer without the suffix or using an arbitrary base, then /// \details If you want to print an Integer without the suffix or using an arbitrary base, then
/// use IntToString<Integer>(). /// use IntToString<Integer>().
/// \sa IntToString<Integer> /// \sa IntToString<Integer>

4
osrng.h
View File

@ -207,12 +207,12 @@ public:
/// \brief Reseed an AutoSeededX917RNG /// \brief Reseed an AutoSeededX917RNG
/// \param blocking controls seeding with BlockingRng or NonblockingRng /// \param blocking controls seeding with BlockingRng or NonblockingRng
/// \param additionalEntropy additional entropy to add to the generator /// \param input additional entropy to add to the generator
/// \param length the size of the additional entropy, in bytes /// \param length the size of the additional entropy, in bytes
/// \details Internally, the generator uses SHA256 to extract the entropy from /// \details Internally, the generator uses SHA256 to extract the entropy from
/// from the seed and then stretch the material for the block cipher's key /// from the seed and then stretch the material for the block cipher's key
/// and initialization vector. /// and initialization vector.
void Reseed(bool blocking = false, const byte *additionalEntropy = NULLPTR, size_t length = 0); void Reseed(bool blocking = false, const byte *input = NULLPTR, size_t length = 0);
/// \brief Deterministically reseed an AutoSeededX917RNG for testing /// \brief Deterministically reseed an AutoSeededX917RNG for testing
/// \param key the key to use for the deterministic reseeding /// \param key the key to use for the deterministic reseeding