From 62de6c8e3bdaeafb8721180f9496c3d77f4e5bc2 Mon Sep 17 00:00:00 2001 From: Jeffrey Walton Date: Mon, 26 Sep 2016 04:49:24 -0400 Subject: [PATCH] Updated documentation --- filters.h | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/filters.h b/filters.h index 525712fa..eb993123 100644 --- a/filters.h +++ b/filters.h @@ -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 lastSize != 0. + //! ForceNextPut() forces a call to NextPut() if this is the case. void ForceNextPut(); protected: