[Scummvm-cvs-logs] SF.net SVN: scummvm:[43465] scummvm/trunk/common/stream.h

[lordhoto at users.sourceforge.net]

Revision: 43465
          http://scummvm.svn.sourceforge.net/scummvm/?rev=43465&view=rev
Author:   lordhoto
Date:     2009-08-17 10:48:03 +0000 (Mon, 17 Aug 2009)

Log Message:
-----------
- Add note about that modifing the parent stream will mess up SeekableSubReadStream and SeekableSubReadStreamEndian.
- Link to SubReadStream documentation from SeekableSubReadStream and SeekableSubReadStreamEndian.

Modified Paths:
--------------
    scummvm/trunk/common/stream.h

Modified: scummvm/trunk/common/stream.h
===================================================================
--- scummvm/trunk/common/stream.h	2009-08-17 10:05:02 UTC (rev 43464)
+++ scummvm/trunk/common/stream.h	2009-08-17 10:48:03 UTC (rev 43465)
@@ -400,6 +400,7 @@
 /**
  * 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 @@
  * 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 @@
 /**
  * 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:


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.