doc/RubyProf.html in ruby-prof-0.15.9 vs doc/RubyProf.html in ruby-prof-0.16.0

- old
+ new

@@ -295,11 +295,11 @@ <div class="method-source-code" id="figure_measure_mode-source"> - <pre><span class="ruby-comment"># File lib/ruby-prof.rb, line 34</span> + <pre><span class="ruby-comment"># File lib/ruby-prof.rb, line 35</span> <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">figure_measure_mode</span> <span class="ruby-keyword">case</span> <span class="ruby-constant">ENV</span>[<span class="ruby-string">&quot;RUBY_PROF_MEASURE_MODE&quot;</span>] <span class="ruby-keyword">when</span> <span class="ruby-string">&quot;wall&quot;</span>, <span class="ruby-string">&quot;wall_time&quot;</span> <span class="ruby-constant">RubyProf</span>.<span class="ruby-identifier">measure_mode</span> = <span class="ruby-constant">RubyProf</span><span class="ruby-operator">::</span><span class="ruby-constant">WALL_TIME</span> <span class="ruby-keyword">when</span> <span class="ruby-string">&quot;cpu&quot;</span>, <span class="ruby-string">&quot;cpu_time&quot;</span> @@ -509,21 +509,21 @@ <div class="method-description"> <p>Returns what ruby-prof is measuring. Valid values include:</p> -<p>*RubyProf::PROCESS_TIME - Measure process time. This is default. It is -implemented using the clock functions in the C Runtime library. -*RubyProf::WALL_TIME - Measure wall time using gettimeofday on Linx and -GetLocalTime on Windows *RubyProf::CPU_TIME - Measure time using the CPU -clock counter. This mode is only supported on Pentium or PowerPC -platforms. *RubyProf::ALLOCATIONS - Measure object allocations. This -requires a patched Ruby interpreter. *RubyProf::MEMORY - Measure memory -size. This requires a patched Ruby interpreter. *RubyProf::GC_RUNS - -Measure number of garbage collections. This requires a patched Ruby -interpreter. *RubyProf::GC_TIME - Measure time spent doing garbage -collection. This requires a patched Ruby interpreter.*/</p> +<p>*RubyProf::WALL_TIME - Measure wall time using gettimeofday on Linx and +GetLocalTime on Windows. This is default. *RubyProf::PROCESS_TIME - +Measure process time. It is implemented using the clock functions in the C +Runtime library. *RubyProf::CPU_TIME - Measure time using the CPU clock +counter. This mode is only supported on Pentium or PowerPC platforms. +*RubyProf::ALLOCATIONS - Measure object allocations. This requires a +patched Ruby interpreter. *RubyProf::MEMORY - Measure memory size. This +requires a patched Ruby interpreter. *RubyProf::GC_RUNS - Measure number of +garbage collections. This requires a patched Ruby interpreter. +*RubyProf::GC_TIME - Measure time spent doing garbage collection. This +requires a patched Ruby interpreter.*/</p> <div class="method-source-code" id="measure_mode-source"> @@ -557,21 +557,21 @@ <div class="method-description"> <p>Specifies what ruby-prof should measure. Valid values include:</p> -<p>*RubyProf::PROCESS_TIME - Measure process time. This is default. It is -implemented using the clock functions in the C Runtime library. -*RubyProf::WALL_TIME - Measure wall time using gettimeofday on Linx and -GetLocalTime on Windows *RubyProf::CPU_TIME - Measure time using the CPU -clock counter. This mode is only supported on Pentium or PowerPC -platforms. *RubyProf::ALLOCATIONS - Measure object allocations. This -requires a patched Ruby interpreter. *RubyProf::MEMORY - Measure memory -size. This requires a patched Ruby interpreter. *RubyProf::GC_RUNS - -Measure number of garbage collections. This requires a patched Ruby -interpreter. *RubyProf::GC_TIME - Measure time spent doing garbage -collection. This requires a patched Ruby interpreter.*/</p> +<p>*RubyProf::WALL_TIME - Measure wall time using gettimeofday on Linx and +GetLocalTime on Windows. This is default. *RubyProf::PROCESS_TIME - +Measure process time. It is implemented using the clock functions in the C +Runtime library. *RubyProf::CPU_TIME - Measure time using the CPU clock +counter. This mode is only supported on Pentium or PowerPC platforms. +*RubyProf::ALLOCATIONS - Measure object allocations. This requires a +patched Ruby interpreter. *RubyProf::MEMORY - Measure memory size. This +requires a patched Ruby interpreter. *RubyProf::GC_RUNS - Measure number of +garbage collections. This requires a patched Ruby interpreter. +*RubyProf::GC_TIME - Measure time spent doing garbage collection. This +requires a patched Ruby interpreter.*/</p> <div class="method-source-code" id="measure_mode-3D-source"> @@ -733,11 +733,11 @@ <div id="method-c-profile" class="method-detail "> <div class="method-heading"> <span class="method-name">profile</span><span - class="method-args">(&block)</span> + class="method-args">(options = {}, &block)</span> <span class="method-click-advice">click to toggle source</span> </div> @@ -749,16 +749,17 @@ <div class="method-source-code" id="profile-source"> <pre><span class="ruby-comment"># File lib/ruby-prof/compatibility.rb, line 142</span> -<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">profile</span>(<span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>) +<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">profile</span>(<span class="ruby-identifier">options</span> = {}, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>) <span class="ruby-identifier">ensure_not_running!</span> <span class="ruby-identifier">gc_stat_was_enabled</span> = <span class="ruby-identifier">enable_gc_stats_if_needed</span> - <span class="ruby-identifier">res</span> = <span class="ruby-constant">Profile</span>.<span class="ruby-identifier">profile</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">measure_mode</span>, <span class="ruby-keyword">self</span>.<span class="ruby-identifier">exclude_threads</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>) + <span class="ruby-identifier">options</span> = { <span class="ruby-identifier">measure_mode</span><span class="ruby-operator">:</span> <span class="ruby-identifier">measure_mode</span>, <span class="ruby-identifier">exclude_threads</span><span class="ruby-operator">:</span> <span class="ruby-identifier">exclude_threads</span> }.<span class="ruby-identifier">merge!</span>(<span class="ruby-identifier">options</span>) + <span class="ruby-identifier">result</span> = <span class="ruby-constant">Profile</span>.<span class="ruby-identifier">profile</span>(<span class="ruby-identifier">options</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>) <span class="ruby-identifier">disable_gc_stats_if_needed</span>(<span class="ruby-identifier">gc_stat_was_enabled</span>) - <span class="ruby-identifier">res</span> + <span class="ruby-identifier">result</span> <span class="ruby-keyword">end</span></pre> </div> </div> @@ -860,11 +861,11 @@ <div class="method-source-code" id="start-source"> <pre><span class="ruby-comment"># File lib/ruby-prof/compatibility.rb, line 106</span> <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">start</span> <span class="ruby-identifier">ensure_not_running!</span> - <span class="ruby-ivar">@profile</span> = <span class="ruby-constant">Profile</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">measure_mode</span>, <span class="ruby-keyword">self</span>.<span class="ruby-identifier">exclude_threads</span>) + <span class="ruby-ivar">@profile</span> = <span class="ruby-constant">Profile</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">measure_mode</span><span class="ruby-operator">:</span> <span class="ruby-identifier">measure_mode</span>, <span class="ruby-identifier">exclude_threads</span><span class="ruby-operator">:</span> <span class="ruby-identifier">exclude_threads</span>) <span class="ruby-identifier">enable_gc_stats_if_needed</span> <span class="ruby-ivar">@profile</span>.<span class="ruby-identifier">start</span> <span class="ruby-keyword">end</span></pre> </div> @@ -953,9 +954,9 @@ </main> <footer id="validator-badges" role="contentinfo"> <p><a href="http://validator.w3.org/check/referer">Validate</a> - <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.0. + <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.2. <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>. </footer>