Update documentation

1 files changed, 15 insertions, 10 deletions

diff --git a/filters.h b/filters.h
index 82bbc95e..fb01d92a 100644
--- a/filters.h
+++ b/filters.h
@@ -101,7 +101,8 @@ protected:
 	/// \param messageEnd means how many filters to signal MessageEnd() to, including this one

 	/// \param blocking specifies whether the object should block when processing input

 	/// \param channel the channel to process the data

-	/// \return the number of bytes that remain to be processed (i.e., bytes not processed)

+	/// \return the number of bytes that remain to be processed (i.e., bytes not processed).

+	///  0 indicates all bytes were processed.

 	size_t Output(int outputSite, const byte *inString, size_t length, int messageEnd, bool blocking, const std::string &channel=DEFAULT_CHANNEL);

 

 	/// \brief Output multiple bytes that may be modified by callee.

@@ -111,7 +112,8 @@ protected:
 	/// \param messageEnd means how many filters to signal MessageEnd() to, including this one

 	/// \param blocking specifies whether the object should block when processing input

 	/// \param channel the channel to process the data

-	/// \return the number of bytes that remain to be processed (i.e., bytes not processed)

+	/// \return the number of bytes that remain to be processed (i.e., bytes not processed).

+	///  0 indicates all bytes were processed.

 	size_t OutputModifiable(int outputSite, byte *inString, size_t length, int messageEnd, bool blocking, const std::string &channel=DEFAULT_CHANNEL);

 

 	/// \brief Signals the end of messages to the object

@@ -119,7 +121,7 @@ protected:
 	/// \param propagation the number of attached transformations the  MessageEnd() signal should be passed

 	/// \param blocking specifies whether the object should block when processing input

 	/// \param channel the channel to process the data

-	/// \return TODO

+	/// \return true is the MessageEnd signal was successful, false otherwise.

 	/// \details propagation count includes this object. Setting  propagation to <tt>1</tt> means this

 	///  object only. Setting propagation to <tt>-1</tt> means unlimited propagation.

 	bool OutputMessageEnd(int outputSite, int propagation, bool blocking, const std::string &channel=DEFAULT_CHANNEL);

@@ -130,7 +132,7 @@ protected:
 	/// \param propagation the number of attached transformations the  Flush() signal should be passed

 	/// \param blocking specifies whether the object should block when processing input

 	/// \param channel the channel to process the data

-	/// \return TODO

+	/// \return true is the Flush signal was successful, false otherwise.

 	/// \details propagation count includes this object. Setting  propagation to <tt>1</tt> means this

 	///  object only. Setting  propagation to <tt>-1</tt> means unlimited propagation.

 	/// \note Hard flushes must be used with care. It means try to process and output everything, even if

@@ -148,7 +150,7 @@ protected:
 	/// \param propagation the number of attached transformations the  MessageSeriesEnd() signal should be passed

 	/// \param blocking specifies whether the object should block when processing input

 	/// \param channel the channel to process the data

-	/// \return TODO

+	/// \return true is the MessageEnd signal was successful, false otherwise.

 	/// \details Each object that receives the signal will perform its processing, decrement

 	///  propagation, and then pass the signal on to attached transformations if the value is not 0.

 	/// \details propagation count includes this object. Setting  propagation to <tt>1</tt> means this

@@ -367,7 +369,7 @@ public:
 	/// \brief Flushes data buffered by this object, without signal propagation

 	/// \param hardFlush indicates whether all data should be flushed

 	/// \param blocking specifies whether the object should block when processing input

-	/// \return true if the flush was successful, false otherwise

+	/// \return true if the Flush was successful, false otherwise

 	/// \details IsolatedFlush() calls ForceNextPut() if hardFlush is true

 	/// \note  hardFlush must be used with care

 	bool IsolatedFlush(bool hardFlush, bool blocking);

@@ -762,7 +764,7 @@ public:
 	size_t ChannelPutModifiable2(const std::string &channel, byte *begin, size_t length, int messageEnd, bool blocking)

 		{ return ChannelPut2(channel, begin, length, messageEnd, blocking); }

 	/// \brief Get verifier result

-	/// \return the hash verifier result

+	/// \return true if the digest on the previosus message was valid, false otherwise

 	bool GetLastResult() const {return m_hashVerifier.GetLastResult();}

 

 protected:

@@ -1342,7 +1344,8 @@ public:
 

 	/// \brief Pump data to attached transformation

 	/// \param pumpMax the maximum number of bytes to pump

-	/// \return the number of bytes that remain to be processed (i.e., bytes not processed)

+	/// \return the number of bytes that remain to be processed (i.e., bytes not processed).

+	///  0 indicates all bytes were processed.

 	/// \details Internally, Pump() calls Pump2().

 	/// \note pumpMax is a <tt>lword</tt>, which is a 64-bit value that typically uses

 	///  <tt>LWORD_MAX</tt>. The default argument is <tt>SIZE_MAX</tt>, and it can be

@@ -1370,7 +1373,8 @@ public:
 	/// \brief Pump data to attached transformation

 	/// \param byteCount the maximum number of bytes to pump

 	/// \param blocking specifies whether the object should block when processing input

-	/// \return the number of bytes that remain to be processed (i.e., bytes not processed)

+	/// \return the number of bytes that remain to be processed (i.e., bytes not processed).

+	///  0 indicates all bytes were processed.

 	/// \details byteCount is an \a IN and \a OUT parameter. When the call is made, byteCount is the

 	///  requested size of the pump. When the call returns, byteCount is the number of bytes that

 	///  were pumped.

@@ -1385,7 +1389,8 @@ public:
 

 	/// \brief Pump all data to attached transformation

 	/// \param blocking specifies whether the object should block when processing input

-	/// \return the number of bytes that remain to be processed (i.e., bytes not processed)

+	/// \return the number of bytes that remain to be processed (i.e., bytes not processed).

+	///  0 indicates all bytes were processed.

 	/// \sa Pump, Pump2, AnyRetrievable, MaxRetrievable

 	virtual size_t PumpAll2(bool blocking=true);