rbs 2.0.0 → 2.2.2

data/core/thread_group.rbs

@@ -1,23 +1,79 @@
-# [ThreadGroup](ThreadGroup) provides a means of
-# keeping track of a number of threads as a group.
-#
-# A given [Thread](https://ruby-doc.org/core-2.6.3/Thread.html) object can
-# only belong to one [ThreadGroup](ThreadGroup) at a
-# time; adding a thread to a new group will remove it from any previous
+# <!-- rdoc-file=thread.c -->
+# ThreadGroup provides a means of keeping track of a number of threads as a
 # group.
 #
-# Newly created threads belong to the same group as the thread from which
-# they were created.
+# A given Thread object can only belong to one ThreadGroup at a time; adding a
+# thread to a new group will remove it from any previous group.
+#
+# Newly created threads belong to the same group as the thread from which they
+# were created.
+#
 class ThreadGroup < Object
+  # <!--
+  #   rdoc-file=thread.c
+  #   - thgrp.add(thread)   -> thgrp
+  # -->
+  # Adds the given `thread` to this group, removing it from any other group to
+  # which it may have previously been a member.
+  #
+  #     puts "Initial group is #{ThreadGroup::Default.list}"
+  #     tg = ThreadGroup.new
+  #     t1 = Thread.new { sleep }
+  #     t2 = Thread.new { sleep }
+  #     puts "t1 is #{t1}"
+  #     puts "t2 is #{t2}"
+  #     tg.add(t1)
+  #     puts "Initial group now #{ThreadGroup::Default.list}"
+  #     puts "tg group now #{tg.list}"
+  #
+  # This will produce:
+  #
+  #     Initial group is #<Thread:0x401bdf4c>
+  #     t1 is #<Thread:0x401b3c90>
+  #     t2 is #<Thread:0x401b3c18>
+  #     Initial group now #<Thread:0x401b3c18>#<Thread:0x401bdf4c>
+  #     tg group now #<Thread:0x401b3c90>
+  #
   def add: (Thread thread) -> ThreadGroup
 
+  # <!--
+  #   rdoc-file=thread.c
+  #   - thgrp.enclose   -> thgrp
+  # -->
+  # Prevents threads from being added to or removed from the receiving
+  # ThreadGroup.
+  #
+  # New threads can still be started in an enclosed ThreadGroup.
+  #
+  #     ThreadGroup::Default.enclose        #=> #<ThreadGroup:0x4029d914>
+  #     thr = Thread.new { Thread.stop }    #=> #<Thread:0x402a7210 sleep>
+  #     tg = ThreadGroup.new                #=> #<ThreadGroup:0x402752d4>
+  #     tg.add thr
+  #     #=> ThreadError: can't move from the enclosed thread group
+  #
   def enclose: () -> self
 
-  # Returns `true` if the `thgrp` is enclosed. See also
-  # [\#enclose](ThreadGroup.downloaded.ruby_doc#method-i-enclose).
+  # <!--
+  #   rdoc-file=thread.c
+  #   - thgrp.enclosed?   -> true or false
+  # -->
+  # Returns `true` if the `thgrp` is enclosed. See also ThreadGroup#enclose.
+  #
   def enclosed?: () -> bool
 
+  # <!--
+  #   rdoc-file=thread.c
+  #   - thgrp.list   -> array
+  # -->
+  # Returns an array of all existing Thread objects that belong to this group.
+  #
+  #     ThreadGroup::Default.list   #=> [#<Thread:0x401bdf4c run>]
+  #
   def list: () -> ::Array[Thread]
 end
 
+# <!-- rdoc-file=thread.c -->
+# The default ThreadGroup created when Ruby starts; all Threads belong to it by
+# default.
+#
 ThreadGroup::Default: ThreadGroup