From cf83ba1da777a9bfc26949afdeabf38e2789060d Mon Sep 17 00:00:00 2001 From: zverok Date: Mon, 20 Dec 2021 09:20:55 +0200 Subject: [PATCH] [DOC] Make sure new GC methods are documented --- gc.rb | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/gc.rb b/gc.rb index 45930c3dab..72637f3796 100644 --- a/gc.rb +++ b/gc.rb @@ -257,13 +257,12 @@ module GC Primitive.gc_verify_compaction_references(double_heap, toward == :empty) end - # :nodoc: # call-seq: # GC.using_rvargc? -> true or false # # Returns true if using experimental feature Variable Width Allocation, false # otherwise. - def self.using_rvargc? + def self.using_rvargc? # :nodoc: GC::INTERNAL_CONSTANTS[:SIZE_POOL_COUNT] > 1 end @@ -272,8 +271,8 @@ module GC # GC.measure_total_time = true/false # # Enable to measure GC time. - # You can get the result with `GC.stat(:time)`. - # Note that the GC time measurement can introduce the performance regression. + # You can get the result with GC.stat(:time). + # Note that GC time measurement can cause some performance overhead. def self.measure_total_time=(flag) Primitive.cstmt! %{ rb_objspace.flags.measure_gc = RTEST(flag) ? TRUE : FALSE; @@ -284,7 +283,7 @@ module GC # call-seq: # GC.measure_total_time -> true/false # - # Return measure_total_time flag (default: true). + # Return measure_total_time flag (default: +true+). # Note that measurement can affect the application performance. def self.measure_total_time Primitive.cexpr! %{