Document that wxStream::Peek() affects LastRead() as expected

This is the case for all streams now after the changes of the previous
commit.
This commit is contained in:
Vadim Zeitlin 2023-08-26 01:51:57 +02:00
parent ffe520cb6d
commit 7758388e9a

View file

@ -610,12 +610,18 @@ public:
int GetC();
/**
Returns the last number of bytes read.
Returns the last number of bytes read by the last input operation.
Such operations include Read(), GetC() and Peek().
*/
virtual size_t LastRead() const;
/**
Returns the first character in the input queue without removing it.
If Peek() failed, e.g. because there is nothing more to read in the
stream, LastRead() will return 0 after calling it, otherwise it will
return 1.
*/
virtual char Peek();