aboutsummaryrefslogtreecommitdiff
path: root/common
diff options
context:
space:
mode:
Diffstat (limited to 'common')
-rw-r--r--common/stream.h7
1 files changed, 7 insertions, 0 deletions
diff --git a/common/stream.h b/common/stream.h
index 9b03c20bd2..86e8e71134 100644
--- a/common/stream.h
+++ b/common/stream.h
@@ -400,6 +400,7 @@ public:
/**
* SubReadStream provides access to a ReadStream restricted to the range
* [currentPosition, currentPosition+end).
+ *
* Manipulating the parent stream directly /will/ mess up a substream.
* Likewise, manipulating two substreams of a parent stream will cause them to
* step on each others toes.
@@ -434,6 +435,9 @@ public:
* SeekableSubReadStream provides access to a SeekableReadStream restricted to
* the range [begin, end).
* The same caveats apply to SeekableSubReadStream as do to SeekableReadStream.
+ *
+ * Manipulating the parent stream directly /will/ mess up a substream.
+ * @see SubReadStream
*/
class SeekableSubReadStream : public SubReadStream, public SeekableReadStream {
protected:
@@ -451,6 +455,9 @@ public:
/**
* This is a wrapper around SeekableSubReadStream, but it adds non-endian
* read methods whose endianness is set on the stream creation.
+ *
+ * Manipulating the parent stream directly /will/ mess up a substream.
+ * @see SubReadStream
*/
class SeekableSubReadStreamEndian : public SeekableSubReadStream {
public: