[Gnash-commit] /srv/bzr/gnash/trunk r10515: document semantic of return value from IOChannel::read(..)

[Sandro Santilli]

------------------------------------------------------------
revno: 10515
committer: Sandro Santilli <address@hidden>
branch nick: trunk
timestamp: Wed 2009-01-07 22:03:01 +0100
message:
  document semantic of return value from IOChannel::read(..)
modified:
  libbase/IOChannel.h

=== modified file 'libbase/IOChannel.h'
--- a/libbase/IOChannel.h       2008-07-10 07:38:46 +0000
+++ b/libbase/IOChannel.h       2009-01-07 21:03:01 +0000
@@ -102,6 +102,9 @@
 
        /// Read the given number of bytes from the stream
        //
+       /// Return the number of bytes actually read. 
+       /// EOF might cause it to be < num.
+       ///
        /// Throw IOException on error
        ///
        virtual int read(void* dst, int num)=0;