summaryrefslogtreecommitdiff
path: root/enumerator.c
diff options
context:
space:
mode:
authormarcandre <marcandre@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2010-05-08 04:58:32 +0000
committermarcandre <marcandre@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2010-05-08 04:58:32 +0000
commitfecc53f0ecbcc514a63d7f3eba3ee0342bbe870d (patch)
tree889ae8454d6b27fb4b80b87e3849630764c07ce3 /enumerator.c
parente9650c0b077707168095891af6419ca148b94b38 (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/branches/ruby_1_9_2@27673 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'enumerator.c')
-rw-r--r--enumerator.c17
1 files changed, 16 insertions, 1 deletions
diff --git a/enumerator.c b/enumerator.c
index 91bb3be14f..64ff841a11 100644
--- a/enumerator.c
+++ b/enumerator.c
@@ -1021,7 +1021,22 @@ generator_each(VALUE obj)
}
/*
- * StopIteration
+ * Document-class: StopIteration
+ *
+ * Raised to stop the iteration, in particular by Enumerator#next. It is
+ * rescued by Kernel#loop.
+ *
+ * loop do
+ * puts "Hello"
+ * raise StopIteration
+ * puts "World"
+ * end
+ * puts "Done!"
+ *
+ * <em>produces:</em>
+ *
+ * Hello
+ * Done!
*/
/*