From fecc53f0ecbcc514a63d7f3eba3ee0342bbe870d Mon Sep 17 00:00:00 2001
From: marcandre <marcandre@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>
Date: Sat, 8 May 2010 04:58:32 +0000
Subject: * error.c: RDoc for subclasses of Exception. [ruby-core:28394]

* cont.c: ditto

* enumerator.c: ditto

* io.c: ditto

* math.c: ditto

* numeric.c: ditto

* proc.c: ditto

* re.c: ditto

* thread.c: ditto

* transcode.c: ditto. Thanks to Run Paint for some of the documentation.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/branches/ruby_1_9_2@27673 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
---
 io.c | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)

(limited to 'io.c')

diff --git a/io.c b/io.c
index c72caae3b9..f9c01f3839 100644
--- a/io.c
+++ b/io.c
@@ -9585,6 +9585,41 @@ rb_get_argv(void)
     return ARGF.argv;
 }
 
+/*
+ * Document-class: IOError
+ *
+ * Raised when an IO operation fails.
+ *
+ *    File.open("/etc/hosts") {|f| f << "example"}
+ *      #=> IOError: not opened for writing
+ *
+ *    File.open("/etc/hosts") {|f| f.close; f.read }
+ *      #=> IOError: closed stream
+ *
+ * Note that some IO failures raise +SystemCallError+s and these are not
+ * subclasses of IOError:
+ *
+ *    File.open("does/not/exist")
+ *      #=> Errno::ENOENT: No such file or directory - does/not/exist
+ */
+
+/*
+* Document-class: EOFError
+*
+ * Raised by some IO operations when reaching the end of file. Many IO
+ * methods exist in two forms,
+ *
+ * one that returns +nil+ when the end of file is reached, the other
+ * raises EOFError +EOFError+.
+ *
+ * +EOFError+ is a subclass of +IOError+.
+ *
+ *    file = File.open("/etc/hosts")
+ *    file.read
+ *    file.gets     #=> nil
+ *    file.readline #=> EOFError: end of file reached
+ */
+
 /*
  * Document-class:  ARGF
  *
-- 
cgit v1.2.3