The EOF logic wasn't quite correct

[libs/core.git] / source / io / base.h

diff --git a/source/io/base.h b/source/io/base.h
index 3d862169177f1711c6a9d3820e4fb3f97a6b94ca..394a2c2306e60ebbe9f8bb7ddee0e1d4f37b4403 100644 (file)
--- a/source/io/base.h
+++ b/source/io/base.h
@@ -87,7 +87,9 @@ protected:
        void set_eof();
 
 public:
-       /** Returns the end-of-file flag. */
+       /** Returns the end-of-file flag.  Note that some types of objects won't
+       indicate end-of-file until you try to read at least one byte past the actual
+       end, while others indicate it when you've read the last byte. */
        bool eof() const { return eof_flag; }
 
        /** Returns the system-level handle for the object.  Used by Console to