arne
/
cryptopp
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Updated documentation

pull/326/head
Jeffrey Walton 2016-10-18 14:42:48 -04:00
parent e794d53806
commit b5f04e5ed5
No known key found for this signature in database
GPG Key ID: B36AB348921B1838
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
filters.h
View File

@ -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