diff options
| author | Jeffrey Walton <noloader@gmail.com> | 2016-09-26 04:49:24 -0400 |
|---|---|---|
| committer | Jeffrey Walton <noloader@gmail.com> | 2016-09-26 04:49:24 -0400 |
| commit | 62de6c8e3bdaeafb8721180f9496c3d77f4e5bc2 (patch) | |
| tree | 89396e562309d3af426c36471c0c29f9c2519a80 /filters.h | |
| parent | b885d6c9adc2a193ee56fa63cb48e07ba098c4ad (diff) | |
| download | cryptopp-git-62de6c8e3bdaeafb8721180f9496c3d77f4e5bc2.tar.gz | |
Updated documentation
Diffstat (limited to 'filters.h')
| -rw-r--r-- | filters.h | 12 |
1 files changed, 8 insertions, 4 deletions
@@ -342,12 +342,16 @@ public: {
return PutMaybeModifiable(inString, length, messageEnd, blocking, true);
}
- /*! calls ForceNextPut() if hardFlush is true */
+
+ //! \brief Releases buffered data for processing
+ //! \param hardFlush
+ //! \param blocking
+ //! \details IsolatedFlush() calls ForceNextPut() if hardFlush is true
bool IsolatedFlush(bool hardFlush, bool blocking);
- /*! The input buffer may contain more than blockSize bytes if lastSize != 0.
- ForceNextPut() forces a call to NextPut() if this is the case.
- */
+ //! \brief Releases buffered data for processing
+ //! \details The input buffer may contain more than blockSize bytes if <tt>lastSize != 0</tt>.
+ //! ForceNextPut() forces a call to NextPut() if this is the case.
void ForceNextPut();
protected:
|