From 55bb2c8b0304ee67b9e2035678661324e3654c63 Mon Sep 17 00:00:00 2001 From: Jeffrey Walton Date: Sat, 27 Oct 2018 02:05:49 -0400 Subject: Update documentation --- filters.h | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) (limited to 'filters.h') diff --git a/filters.h b/filters.h index 85c048da..019bdabe 100644 --- a/filters.h +++ b/filters.h @@ -1296,8 +1296,8 @@ public: /// \returns the number of bytes that remain in the block (i.e., bytes not processed) /// \details Internally, Pump() calls Pump2(). /// \note pumpMax is a lword, which is a 64-bit value that typically uses - /// LWORD_MAX. The default argument is a size_t that uses - /// SIZE_MAX, and it can be 32-bits or 64-bits. + /// LWORD_MAX. The default argument is SIZE_MAX, and it can be + /// 32-bits or 64-bits. /// \sa Pump2, PumpAll, AnyRetrievable, MaxRetrievable lword Pump(lword pumpMax=SIZE_MAX) {Pump2(pumpMax); return pumpMax;} @@ -1311,7 +1311,8 @@ public: /// \brief Pump all data to attached transformation /// \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(). /// \sa Pump, Pump2, AnyRetrievable, MaxRetrievable void PumpAll() -- cgit v1.2.1