diff options
author | Jeffrey Walton <noloader@gmail.com> | 2016-10-18 14:42:48 -0400 |
---|---|---|
committer | Jeffrey Walton <noloader@gmail.com> | 2016-10-18 14:42:48 -0400 |
commit | b5f04e5ed5738b764e1a56e50326b5d667439bb1 (patch) | |
tree | 03efc48abbbaec93278205e075b078a483e4fa1a | |
parent | e794d538064574d1824b3064964a2da3d8049f2d (diff) | |
download | cryptopp-git-b5f04e5ed5738b764e1a56e50326b5d667439bb1.tar.gz |
Updated documentation
-rw-r--r-- | filters.h | 11 |
1 files changed, 9 insertions, 2 deletions
@@ -1052,8 +1052,11 @@ private: T *m_output;
};
-CRYPTOPP_DLL_TEMPLATE_CLASS StringSinkTemplate<std::string>;
+//! \class StringSink
+//! \brief Append input to a string object
+//! \details StringSink is a typedef for StringSinkTemplate<std::string>.
DOCUMENTED_TYPEDEF(StringSinkTemplate<std::string>, StringSink);
+CRYPTOPP_DLL_TEMPLATE_CLASS StringSinkTemplate<std::string>;
//! \class RandomNumberSink
//! \brief Incorporates input into RNG as additional entropy
@@ -1336,7 +1339,11 @@ public: : SourceTemplate<StringStore>(attachment) {SourceInitialize(pumpAll, MakeParameters("InputBuffer", ConstByteArrayParameter(string)));}
};
-// Use the third constructor for an array source
+//! \class ArraySource
+//! \brief Pointer-based implementation of the Source interface
+//! \details ArraySource is a typedef for StringSource. Use the third constructor for an array source.
+//! The third constructor takes a pointer and length.
+//! \since Crypto++ 5.6.0
DOCUMENTED_TYPEDEF(StringSource, ArraySource);
//! RNG-based implementation of Source interface
|