100% documentation coverage.

Author: ioquatix

lib/memory/graph.rb

@@ -11,12 +11,17 @@ module Memory
 	module Graph
 		IGNORE = Usage::IGNORE
 
-		# Represents a node in the object graph with usage information.
-		class Node
-			def initialize(object, usage = Usage.new, parent = nil, reference: nil)
-				@object = object
-				@usage = usage
-				@parent = parent
+	# Represents a node in the object graph with usage information.
+	class Node
+		# Initialize a new node in the object graph.
+		# @parameter object [Object] The object this node represents.
+		# @parameter usage [Usage] The memory usage of this object.
+		# @parameter parent [Node | Nil] The parent node in the traversal tree.
+		# @parameter reference [Symbol | Nil] The reference type from parent to this object.
+		def initialize(object, usage = Usage.new, parent = nil, reference: nil)
+			@object = object
+			@usage = usage
+			@parent = parent
 				@children = nil
 
 				@reference = reference || parent&.find_reference(object)

lib/memory/usage.rb

@@ -9,7 +9,13 @@
 require "objspace"
 
 module Memory
+	# Tracks memory usage statistics including size and object count.
+	#
+	# Can be used to measure allocations or compute usage of object graphs.
 	class Usage
+		# Initialize a new usage tracker.
+		# @parameter size [Integer] The total size in bytes.
+		# @parameter count [Integer] The total count of objects.
 		def initialize(size = 0, count = 0)
 			@size = size
 			@count = count
@@ -100,22 +106,29 @@ def self.of(root, seen: Set.new.compare_by_identity, ignore: IGNORE)
 				end
 			end
 
-			return new(size, count)
-		end
-		
-		def as_json(...)
-			{
-				size: @size,
-				count: @count
-			}
-		end
-		
-		def to_json(...)
-			as_json.to_json(...)
-		end
-		
-		def to_s
-			"(#{Memory.formatted_bytes(@size)} in #{@count} allocations)"
-		end
+		return new(size, count)
+	end
+	
+	# Convert this usage to a JSON-compatible hash.
+	# @parameter options [Hash | Nil] Optional JSON serialization options.
+	# @returns [Hash] Hash with `:size` and `:count` keys.
+	def as_json(...)
+		{
+			size: @size,
+			count: @count
+		}
+	end
+	
+	# Convert this usage to a JSON string.
+	# @returns [String] JSON representation of this usage.
+	def to_json(...)
+		as_json.to_json(...)
+	end
+	
+	# Generate a human-readable string representation.
+	# @returns [String] Formatted string showing size and allocation count.
+	def to_s
+		"(#{Memory.formatted_bytes(@size)} in #{@count} allocations)"
+	end
 	end
 end