diff options
author | zverok <zverok.offline@gmail.com> | 2021-12-20 09:20:55 +0200 |
---|---|---|
committer | Koichi Sasada <ko1@atdot.net> | 2021-12-24 10:36:29 +0900 |
commit | cf83ba1da777a9bfc26949afdeabf38e2789060d (patch) | |
tree | 4ca0716fbabdaf932058070ad6581632f9f511d3 /gc.rb | |
parent | b0ad6cb371747a04eb12580e74c73179173cc89d (diff) |
[DOC] Make sure new GC methods are documented
Notes
Notes:
Merged: https://github.com/ruby/ruby/pull/5306
Diffstat (limited to 'gc.rb')
-rw-r--r-- | gc.rb | 9 |
1 files changed, 4 insertions, 5 deletions
@@ -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 <tt>GC.stat(:time)</tt>. + # 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! %{ |