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

Update documentation

pull/730/head
Jeffrey Walton 2018-10-27 02:05:49 -04:00
parent 2b4911abee
commit 55bb2c8b03
No known key found for this signature in database
GPG Key ID: B36AB348921B1838
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
filters.h
View File

@ -1296,8 +1296,8 @@ public:
/// \returns the number of bytes that remain in the block (i.e., bytes not processed) /// \returns the number of bytes that remain in the block (i.e., bytes not processed)
/// \details Internally, Pump() calls Pump2(). /// \details Internally, Pump() calls Pump2().
/// \note pumpMax is a <tt>lword</tt>, which is a 64-bit value that typically uses /// \note pumpMax is a <tt>lword</tt>, which is a 64-bit value that typically uses
/// <tt>LWORD_MAX</tt>. The default argument is a <tt>size_t</tt> that uses /// <tt>LWORD_MAX</tt>. The default argument is <tt>SIZE_MAX</tt>, and it can be
/// <tt>SIZE_MAX</tt>, and it can be 32-bits or 64-bits. /// 32-bits or 64-bits.
/// \sa Pump2, PumpAll, AnyRetrievable, MaxRetrievable /// \sa Pump2, PumpAll, AnyRetrievable, MaxRetrievable
lword Pump(lword pumpMax=SIZE_MAX) lword Pump(lword pumpMax=SIZE_MAX)
{Pump2(pumpMax); return pumpMax;} {Pump2(pumpMax); return pumpMax;}
@ -1311,7 +1311,8 @@ public:
/// \brief Pump all data to attached transformation /// \brief Pump all data to attached transformation
/// \details Pumps all data to the attached transformation and signal the end of the current /// \details Pumps all data to the attached transformation and signal the end of the current
/// message. To avoid the MessageEnd() signal call Pump(LWORD_MAX) or Pump2(LWORD_MAX, bool). /// message. To avoid the MessageEnd() signal call \ref Pump "Pump(LWORD_MAX)" or \ref Pump2
/// "Pump2(LWORD_MAX, bool)".
/// \details Internally, PumpAll() calls PumpAll2(), which calls PumpMessages(). /// \details Internally, PumpAll() calls PumpAll2(), which calls PumpMessages().
/// \sa Pump, Pump2, AnyRetrievable, MaxRetrievable /// \sa Pump, Pump2, AnyRetrievable, MaxRetrievable
void PumpAll() void PumpAll()