summaryrefslogtreecommitdiff
path: root/cont.c
diff options
context:
space:
mode:
authormarcandre <marcandre@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2010-05-08 04:50:09 +0000
committermarcandre <marcandre@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2010-05-08 04:50:09 +0000
commit1dee5e34a3d397eb96db0b6bcc8e9cb9858975d0 (patch)
tree5822fdfead1635f2f78cfd0ee69bd61c217ad07f /cont.c
parentb140b77926a6e62228f1152157d0348ff5724f89 (diff)
* 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/trunk@27671 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'cont.c')
-rw-r--r--cont.c15
1 files changed, 15 insertions, 0 deletions
diff --git a/cont.c b/cont.c
index c164a3554b..fb0959d1b9 100644
--- a/cont.c
+++ b/cont.c
@@ -1422,6 +1422,21 @@ rb_fiber_s_current(VALUE klass)
return rb_fiber_current();
}
+
+
+/*
+ * Document-class: FiberError
+ *
+ * Raised when an invalid operation is attempted on a Fiber, in
+ * particular when attempting to call/resume a dead fiber,
+ * attempting to yield from the root fiber, or calling a fiber across
+ * threads.
+ *
+ * fiber = Fiber.new{}
+ * fiber.resume #=> nil
+ * fiber.resume #=> FiberError: dead fiber called
+ */
+
void
Init_Cont(void)
{