From b0a5ec8947be27ba8fb99a17f0da905994bd7cd6 Mon Sep 17 00:00:00 2001
From: Johannes Schickel
Date: Mon, 17 Aug 2009 10:48:03 +0000
Subject: - Add note about that modifing the parent stream will mess up
 SeekableSubReadStream and SeekableSubReadStreamEndian. - Link to
 SubReadStream documentation from SeekableSubReadStream and
 SeekableSubReadStreamEndian.

svn-id: r43465
---
 common/stream.h | 7 +++++++
 1 file changed, 7 insertions(+)

(limited to 'common')

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:
-- 
cgit v1.2.3