From fe9817618d0d3b382e440e6fbd08540b53354986 Mon Sep 17 00:00:00 2001 From: nobu Date: Thu, 17 Mar 2016 08:20:29 +0000 Subject: [PATCH] thread_sync.c: Update rdoc for Queue [skip ci] * thread_sync.c: [DOC] Update documentation for Queue class description. [Fix GH-1292] git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@54146 b2dd03c8-39d4-4d8f-98ff-823fe69b080e --- ChangeLog | 5 +++++ thread_sync.c | 8 +++++++- 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/ChangeLog b/ChangeLog index a60122f643..a762c5315c 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +Thu Mar 17 17:20:28 2016 Anton Davydov + + * thread_sync.c: [DOC] Update documentation for Queue class + description. [Fix GH-1292] + Thu Mar 17 17:14:51 2016 Dinar Valeev * gc.c (tick): Use __builtin_ppc_get_timebase for POWER arch. diff --git a/thread_sync.c b/thread_sync.c index 9ac28a9aa0..9de9c32965 100644 --- a/thread_sync.c +++ b/thread_sync.c @@ -632,7 +632,13 @@ queue_do_close(VALUE self, int is_szq) /* * Document-class: Queue * - * This class provides a way to synchronize communication between threads. + * The Queue class implements multi-producer, multi-consumer queues. + * It is especially useful in threaded programming when information + * must be exchanged safely between multiple threads. The Queue class + * implements all the required locking semantics. + * + * The class implements FIFO type of queue. In a FIFO queue, the first + * tasks added are the first retrieved. * * Example: *