diff options
author | Jeffrey Walton <noloader@gmail.com> | 2017-11-29 10:54:33 -0500 |
---|---|---|
committer | Jeffrey Walton <noloader@gmail.com> | 2017-11-29 10:54:33 -0500 |
commit | 61ec50dabe14c5d4582ac187706ea27645b3562b (patch) | |
tree | 18a2eebb7adc8c9556ce132d7081a105fa058d6b /zinflate.h | |
parent | 16ebfa72bf130c4725e652e4d3688d97d3feb0ee (diff) | |
download | cryptopp-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 'zinflate.h')
-rw-r--r-- | zinflate.h | 30 |
1 files changed, 15 insertions, 15 deletions
@@ -8,8 +8,8 @@ NAMESPACE_BEGIN(CryptoPP)
-//! \class LowFirstBitReader
-//! \since Crypto++ 1.0
+/// \class LowFirstBitReader
+/// \since Crypto++ 1.0
class LowFirstBitReader
{
public:
@@ -30,9 +30,9 @@ private: struct CodeLessThan;
-//! \class HuffmanDecoder
-//! \brief Huffman Decoder
-//! \since Crypto++ 1.0
+/// \class HuffmanDecoder
+/// \brief Huffman Decoder
+/// \since Crypto++ 1.0
class HuffmanDecoder
{
public:
@@ -86,9 +86,9 @@ private: mutable std::vector<LookupEntry, AllocatorWithCleanup<LookupEntry> > m_cache;
};
-//! \class Inflator
-//! \brief DEFLATE decompressor (RFC 1951)
-//! \since Crypto++ 1.0
+/// \class Inflator
+/// \brief DEFLATE decompressor (RFC 1951)
+/// \since Crypto++ 1.0
class Inflator : public AutoSignaling<Filter>
{
public:
@@ -98,17 +98,17 @@ public: Err(ErrorType e, const std::string &s)
: Exception(e, s) {}
};
- //! \brief Exception thrown when a truncated stream is encountered
+ /// \brief Exception thrown when a truncated stream is encountered
class UnexpectedEndErr : public Err {public: UnexpectedEndErr() : Err(INVALID_DATA_FORMAT, "Inflator: unexpected end of compressed block") {}};
- //! \brief Exception thrown when a bad block is encountered
+ /// \brief Exception thrown when a bad block is encountered
class BadBlockErr : public Err {public: BadBlockErr() : Err(INVALID_DATA_FORMAT, "Inflator: error in compressed block") {}};
- //! \brief Exception thrown when an invalid distance is encountered
+ /// \brief Exception thrown when an invalid distance is encountered
class BadDistanceErr : public Err {public: BadDistanceErr() : Err(INVALID_DATA_FORMAT, "Inflator: error in bit distance") {}};
- //! \brief RFC 1951 Decompressor
- //! \param attachment the filter's attached transformation
- //! \param repeat decompress multiple compressed streams in series
- //! \param autoSignalPropagation 0 to turn off MessageEnd signal
+ /// \brief RFC 1951 Decompressor
+ /// \param attachment the filter's attached transformation
+ /// \param repeat decompress multiple compressed streams in series
+ /// \param autoSignalPropagation 0 to turn off MessageEnd signal
Inflator(BufferedTransformation *attachment = NULLPTR, bool repeat = false, int autoSignalPropagation = -1);
void IsolatedInitialize(const NameValuePairs ¶meters);
|