From 314e43adfc43bf906d8b37453f434b210d908a37 Mon Sep 17 00:00:00 2001
From: matz <matz@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>
Date: Mon, 31 Jul 2006 06:34:10 +0000
Subject: * ruby.h: use ifdef (or defined) for macro constants that may or  
 may not be defined to shut up gcc's -Wundef warnings.   [ruby-core:08447]

git-svn-id: http://svn.ruby-lang.org/repos/ruby/branches/ruby_1_8@10648 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
---
 lib/readbytes.rb | 5 +++++
 1 file changed, 5 insertions(+)

(limited to 'lib/readbytes.rb')

diff --git a/lib/readbytes.rb b/lib/readbytes.rb
index d6a3b10af..08b92da73 100644
--- a/lib/readbytes.rb
+++ b/lib/readbytes.rb
@@ -12,6 +12,11 @@ class TruncatedDataError<IOError
 end
 
 class IO
+  # reads exactly n bytes from the IO stream.
+  # If the data read is nil, raises EOFError.
+  # If the data read is too short, raises TruncatedDataError.
+  # The method TruncatedDataError#data may be used to obtain
+  # the truncated message.
   def readbytes(n)
     str = read(n)
     if str == nil
-- 
cgit