Improve documentation of #each* methods

mhib · Feb 4, 2023 · 375465c · 375465c
1 parent 6ebd5e9
commit 375465c
Showing 1 changed file with 7 additions and 3 deletions.
diff --git a/lib/pairing_heap.rb b/lib/pairing_heap.rb
@@ -260,6 +260,7 @@ def get_priority_if_exists(elem)
 
     # Returns enumerator of elements.
     # @note There are no order guarantees.
+    # @yieldparam [Object] element Element in the heap
     # @return [Enumerator<Object>]
     def each
       return to_enum(__method__) { size } unless block_given?
@@ -268,7 +269,8 @@ def each
 
     # Returns enumerator of elements.
     # @note There are no order guarantees.
-    # @return [Enumerator<Array(Object, Object)>]
+    # @return [Enumerator<Array(Object, Object)>] if no block given
+    # @yieldparam [Array(Object, Object)] element Element in the heap with its priority
     def each_with_priority
       return to_enum(__method__) { size } unless block_given?
       @nodes.each_value { |node| yield [node.elem, node.priority] }
@@ -407,13 +409,15 @@ def pop_with_priority
 
     # Returns enumerator of elements.
     # @note There are no order guarantees.
-    # @return [Enumerator]
+    # @yieldparam [Object] element element in the heap
+    # @return [Enumerator<Object>] if no block given
     def each
       return to_enum(__method__) { size } unless block_given?
       NodeVisitor.visit_node(@root) { |x| yield x.elem }
     end
 
-    # @return [Enumerator<Array(object, object)>]
+    # @return [Enumerator<Array(Object, Object)>] if no block given
+    # @yieldparam [Array(Object, Object)] element Element in the heap with its priority
     # Returns enumerator of elements.
     # @note There are no order guarantees.
     def each_with_priority