summaryrefslogtreecommitdiff
path: root/cryptlib.cpp
diff options
context:
space:
mode:
authorJeffrey Walton <noloader@gmail.com>2017-11-29 10:54:33 -0500
committerJeffrey Walton <noloader@gmail.com>2017-11-29 10:54:33 -0500
commit61ec50dabe14c5d4582ac187706ea27645b3562b (patch)
tree18a2eebb7adc8c9556ce132d7081a105fa058d6b /cryptlib.cpp
parent16ebfa72bf130c4725e652e4d3688d97d3feb0ee (diff)
downloadcryptopp-git-61ec50dabe14c5d4582ac187706ea27645b3562b.tar.gz
Change Doxygen comment style from //! to ///
Also see https://groups.google.com/forum/#!topic/cryptopp-users/A7-Xt5Knlzw
Diffstat (limited to 'cryptlib.cpp')
-rw-r--r--cryptlib.cpp32
1 files changed, 16 insertions, 16 deletions
diff --git a/cryptlib.cpp b/cryptlib.cpp
index a9722159..03f0f0ff 100644
--- a/cryptlib.cpp
+++ b/cryptlib.cpp
@@ -330,28 +330,28 @@ void RandomNumberGenerator::GenerateIntoBufferedTransformation(BufferedTransform
}
}
-//! \class ClassNullRNG
-//! \brief Random Number Generator that does not produce random numbers
-//! \details ClassNullRNG can be used for functions that require a RandomNumberGenerator
-//! but don't actually use it. The class throws NotImplemented when a generation function is called.
-//! \sa NullRNG()
+/// \class ClassNullRNG
+/// \brief Random Number Generator that does not produce random numbers
+/// \details ClassNullRNG can be used for functions that require a RandomNumberGenerator
+/// but don't actually use it. The class throws NotImplemented when a generation function is called.
+/// \sa NullRNG()
class ClassNullRNG : public RandomNumberGenerator
{
public:
- //! \brief The name of the generator
- //! \returns the string \a NullRNGs
+ /// \brief The name of the generator
+ /// \returns the string \a NullRNGs
std::string AlgorithmName() const {return "NullRNG";}
#if defined(CRYPTOPP_DOXYGEN_PROCESSING)
- //! \brief An implementation that throws NotImplemented
+ /// \brief An implementation that throws NotImplemented
byte GenerateByte () {}
- //! \brief An implementation that throws NotImplemented
+ /// \brief An implementation that throws NotImplemented
unsigned int GenerateBit () {}
- //! \brief An implementation that throws NotImplemented
+ /// \brief An implementation that throws NotImplemented
word32 GenerateWord32 (word32 min, word32 max) {}
#endif
- //! \brief An implementation that throws NotImplemented
+ /// \brief An implementation that throws NotImplemented
void GenerateBlock(byte *output, size_t size)
{
CRYPTOPP_UNUSED(output); CRYPTOPP_UNUSED(size);
@@ -359,15 +359,15 @@ public:
}
#if defined(CRYPTOPP_DOXYGEN_PROCESSING)
- //! \brief An implementation that throws NotImplemented
+ /// \brief An implementation that throws NotImplemented
void GenerateIntoBufferedTransformation (BufferedTransformation &target, const std::string &channel, lword length) {}
- //! \brief An implementation that throws NotImplemented
+ /// \brief An implementation that throws NotImplemented
void IncorporateEntropy (const byte *input, size_t length) {}
- //! \brief An implementation that returns \p false
+ /// \brief An implementation that returns \p false
bool CanIncorporateEntropy () const {}
- //! \brief An implementation that does nothing
+ /// \brief An implementation that does nothing
void DiscardBytes (size_t n) {}
- //! \brief An implementation that does nothing
+ /// \brief An implementation that does nothing
void Shuffle (IT begin, IT end) {}
private: