doc/RubyProf/ProfileTask.html in ruby-prof-0.13.1 vs doc/RubyProf/ProfileTask.html in ruby-prof-0.14.0
- old
+ new
@@ -1,170 +1,104 @@
<!DOCTYPE html>
<html>
<head>
-<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
+<meta charset="UTF-8">
<title>class RubyProf::ProfileTask - ruby-prof</title>
-<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet">
+<link href="../fonts.css" rel="stylesheet">
+<link href="../rdoc.css" rel="stylesheet">
<script type="text/javascript">
var rdoc_rel_prefix = "../";
</script>
-<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
-<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script>
-<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script>
-<script type="text/javascript" charset="utf-8" src="../js/search.js"></script>
-<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script>
-<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script>
+<script src="../js/jquery.js"></script>
+<script src="../js/navigation.js"></script>
+<script src="../js/search_index.js"></script>
+<script src="../js/search.js"></script>
+<script src="../js/searcher.js"></script>
+<script src="../js/darkfish.js"></script>
-<body id="top" class="class">
-<nav id="metadata">
- <nav id="home-section" class="section">
- <h3 class="section-header">
- <a href="../index.html">Home</a>
+<body id="top" role="document" class="class">
+<nav role="navigation">
+ <div id="project-navigation">
+ <div id="home-section" role="region" title="Quick navigation" class="nav-section">
+ <h2>
+ <a href="../index.html" rel="home">Home</a>
+ </h2>
+
+ <div id="table-of-contents-navigation">
+ <a href="../table_of_contents.html#pages">Pages</a>
<a href="../table_of_contents.html#classes">Classes</a>
<a href="../table_of_contents.html#methods">Methods</a>
- </h3>
-</nav>
+ </div>
+</div>
-
- <nav id="search-section" class="section project-section" class="initially-hidden">
+ <div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
- <h3 class="section-header">
- <input type="text" name="search" placeholder="Search" id="search-field"
+ <div id="search-field-wrapper">
+ <input id="search-field" role="combobox" aria-label="Search"
+ aria-autocomplete="list" aria-controls="search-results"
+ type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
- </h3>
+ </div>
+
+ <ul id="search-results" aria-label="Search Results"
+ aria-busy="false" aria-expanded="false"
+ aria-atomic="false" class="initially-hidden"></ul>
</form>
+</div>
- <ul id="search-results" class="initially-hidden"></ul>
-</nav>
-
-
- <div id="file-metadata">
- <nav id="file-list-section" class="section">
- <h3 class="section-header">Defined In</h3>
- <ul>
- <li>lib/ruby-prof/task.rb
- </ul>
-</nav>
-
-
</div>
+
+
<div id="class-metadata">
- <nav id="parent-class-section" class="section">
- <h3 class="section-header">Parent</h3>
+ <div id="parent-class-section" class="nav-section">
+ <h3>Parent</h3>
+
<p class="link">Rake::TestTask
-</nav>
+</div>
+
<!-- Method Quickref -->
-<nav id="method-list-section" class="section">
- <h3 class="section-header">Methods</h3>
+<div id="method-list-section" class="nav-section">
+ <h3>Methods</h3>
- <ul class="link-list">
+ <ul class="link-list" role="directory">
- <li><a href="#method-c-new">::new</a>
+ <li class="calls-super" ><a href="#method-c-new">::new</a>
- <li><a href="#method-i-clean_output_directory">#clean_output_directory</a>
+ <li ><a href="#method-i-clean_output_directory">#clean_output_directory</a>
- <li><a href="#method-i-create_output_directory">#create_output_directory</a>
+ <li ><a href="#method-i-create_output_directory">#create_output_directory</a>
- <li><a href="#method-i-define">#define</a>
+ <li ><a href="#method-i-define">#define</a>
- <li><a href="#method-i-output_directory">#output_directory</a>
+ <li ><a href="#method-i-output_directory">#output_directory</a>
- <li><a href="#method-i-run_script">#run_script</a>
+ <li ><a href="#method-i-run_script">#run_script</a>
</ul>
-</nav>
+</div>
</div>
-
- <div id="project-metadata">
- <nav id="fileindex-section" class="section project-section">
- <h3 class="section-header">Pages</h3>
-
- <ul>
-
- <li class="file"><a href="../LICENSE.html">LICENSE</a>
-
- <li class="file"><a href="../README_rdoc.html">README</a>
-
- <li class="file"><a href="../examples/flat_txt.html">flat</a>
-
- <li class="file"><a href="../examples/graph_txt.html">graph</a>
-
- </ul>
</nav>
- <nav id="classindex-section" class="section project-section">
- <h3 class="section-header">Class and Module Index</h3>
+<main role="main" aria-labelledby="class-RubyProf::ProfileTask">
+ <h1 id="class-RubyProf::ProfileTask" class="class">
+ class RubyProf::ProfileTask
+ </h1>
- <ul class="link-list">
-
- <li><a href="../RubyProf.html">RubyProf</a>
-
- <li><a href="../RubyProf/AbstractPrinter.html">RubyProf::AbstractPrinter</a>
-
- <li><a href="../RubyProf/AggregateCallInfo.html">RubyProf::AggregateCallInfo</a>
-
- <li><a href="../RubyProf/CallInfo.html">RubyProf::CallInfo</a>
-
- <li><a href="../RubyProf/CallInfoPrinter.html">RubyProf::CallInfoPrinter</a>
-
- <li><a href="../RubyProf/CallInfoVisitor.html">RubyProf::CallInfoVisitor</a>
-
- <li><a href="../RubyProf/CallStackPrinter.html">RubyProf::CallStackPrinter</a>
-
- <li><a href="../RubyProf/CallTreePrinter.html">RubyProf::CallTreePrinter</a>
-
- <li><a href="../RubyProf/Cmd.html">RubyProf::Cmd</a>
-
- <li><a href="../RubyProf/DotPrinter.html">RubyProf::DotPrinter</a>
-
- <li><a href="../RubyProf/FlatPrinter.html">RubyProf::FlatPrinter</a>
-
- <li><a href="../RubyProf/FlatPrinterWithLineNumbers.html">RubyProf::FlatPrinterWithLineNumbers</a>
-
- <li><a href="../RubyProf/GraphHtmlPrinter.html">RubyProf::GraphHtmlPrinter</a>
-
- <li><a href="../RubyProf/GraphPrinter.html">RubyProf::GraphPrinter</a>
-
- <li><a href="../RubyProf/MethodInfo.html">RubyProf::MethodInfo</a>
-
- <li><a href="../RubyProf/MultiPrinter.html">RubyProf::MultiPrinter</a>
-
- <li><a href="../RubyProf/Profile.html">RubyProf::Profile</a>
-
- <li><a href="../RubyProf/ProfileTask.html">RubyProf::ProfileTask</a>
-
- <li><a href="../RubyProf/Test.html">RubyProf::Test</a>
-
- <li><a href="../RubyProf/Thread.html">RubyProf::Thread</a>
-
- <li><a href="../Rack.html">Rack</a>
-
- <li><a href="../Rack/RubyProf.html">Rack::RubyProf</a>
-
- </ul>
-</nav>
-
- </div>
-</nav>
-
-<div id="documentation">
- <h1 class="class">class RubyProf::ProfileTask</h1>
-
- <div id="description" class="description">
+ <section class="description">
<p>Define a task library for profiling unit tests with ruby-prof.</p>
<p>All of the options provided by the Rake:TestTask are supported except the
loader which is set to ruby-prof. For detailed information please refer to
@@ -211,11 +145,11 @@
<pre>rake profile # run tests normally
rake profile TEST=just_one_file.rb # run just one test file.
rake profile TESTOPTS="-v" # run in verbose mode
rake profile TESTOPTS="--runner=fox" # use the fox test runner</pre>
- </div><!-- description -->
+ </section>
<section id="5Buntitled-5D" class="documentation-section">
@@ -224,13 +158,14 @@
- <!-- Attributes -->
- <section id="attribute-method-details" class="method-section section">
- <h3 class="section-header">Attributes</h3>
+ <section class="attribute-method-details" class="method-section">
+ <header>
+ <h3>Attributes</h3>
+ </header>
<div id="attribute-i-min_percent" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">min_percent</span><span
@@ -268,137 +203,157 @@
</div>
</div>
- </section><!-- attribute-method-details -->
+ </section>
- <!-- Methods -->
- <section id="public-class-5Buntitled-5D-method-details" class="method-section section">
- <h3 class="section-header">Public Class Methods</h3>
+ <section id="public-class-5Buntitled-5D-method-details" class="method-section">
+ <header>
+ <h3>Public Class Methods</h3>
+ </header>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(name = :profile)</span>
+
<span class="method-click-advice">click to toggle source</span>
+
</div>
<div class="method-description">
+
+ <div class="method-calls-super">
+ Calls superclass method
+
+ </div>
+
<div class="method-source-code" id="new-source">
- <pre><span class="ruby-comment"># File lib/ruby-prof/task.rb, line 63</span>
+ <pre><span class="ruby-comment"># File lib/ruby-prof/task.rb, line 64</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">name</span> = <span class="ruby-value">:profile</span>)
<span class="ruby-keyword">super</span>(<span class="ruby-identifier">name</span>)
<span class="ruby-keyword">end</span></pre>
- </div><!-- new-source -->
+ </div>
</div>
- </div><!-- new-method -->
+ </div>
- </section><!-- public-class-method-details -->
+ </section>
- <section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
- <h3 class="section-header">Public Instance Methods</h3>
+ <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
+ <header>
+ <h3>Public Instance Methods</h3>
+ </header>
<div id="method-i-clean_output_directory" class="method-detail ">
<div class="method-heading">
<span class="method-name">clean_output_directory</span><span
class="method-args">()</span>
+
<span class="method-click-advice">click to toggle source</span>
+
</div>
<div class="method-description">
+
<div class="method-source-code" id="clean_output_directory-source">
- <pre><span class="ruby-comment"># File lib/ruby-prof/task.rb, line 134</span>
+ <pre><span class="ruby-comment"># File lib/ruby-prof/task.rb, line 135</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">clean_output_directory</span>
<span class="ruby-keyword">if</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-identifier">output_directory</span>)
<span class="ruby-identifier">files</span> = <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">glob</span>(<span class="ruby-identifier">output_directory</span> <span class="ruby-operator">+</span> <span class="ruby-string">'/*'</span>)
<span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">rm</span>(<span class="ruby-identifier">files</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
- </div><!-- clean_output_directory-source -->
+ </div>
</div>
- </div><!-- clean_output_directory-method -->
+ </div>
<div id="method-i-create_output_directory" class="method-detail ">
<div class="method-heading">
<span class="method-name">create_output_directory</span><span
class="method-args">()</span>
+
<span class="method-click-advice">click to toggle source</span>
+
</div>
<div class="method-description">
+
<div class="method-source-code" id="create_output_directory-source">
- <pre><span class="ruby-comment"># File lib/ruby-prof/task.rb, line 128</span>
+ <pre><span class="ruby-comment"># File lib/ruby-prof/task.rb, line 129</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">create_output_directory</span>
<span class="ruby-keyword">if</span> <span class="ruby-keyword">not</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-identifier">output_directory</span>)
<span class="ruby-constant">Dir</span>.<span class="ruby-identifier">mkdir</span>(<span class="ruby-identifier">output_directory</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
- </div><!-- create_output_directory-source -->
+ </div>
</div>
- </div><!-- create_output_directory-method -->
+ </div>
<div id="method-i-define" class="method-detail ">
<div class="method-heading">
<span class="method-name">define</span><span
class="method-args">()</span>
+
<span class="method-click-advice">click to toggle source</span>
+
</div>
<div class="method-description">
<p>Create the tasks defined by this task lib.</p>
+
<div class="method-source-code" id="define-source">
- <pre><span class="ruby-comment"># File lib/ruby-prof/task.rb, line 68</span>
+ <pre><span class="ruby-comment"># File lib/ruby-prof/task.rb, line 69</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">define</span>
<span class="ruby-identifier">lib_path</span> = <span class="ruby-ivar">@libs</span>.<span class="ruby-identifier">join</span>(<span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">PATH_SEPARATOR</span>)
<span class="ruby-identifier">desc</span> <span class="ruby-string">"Profile"</span> <span class="ruby-operator">+</span> (<span class="ruby-ivar">@name</span><span class="ruby-operator">==</span><span class="ruby-value">:profile</span> <span class="ruby-operator">?</span> <span class="ruby-string">""</span> <span class="ruby-operator">:</span> <span class="ruby-node">" for #{@name}"</span>)
<span class="ruby-identifier">task</span> <span class="ruby-ivar">@name</span> <span class="ruby-keyword">do</span>
@@ -414,67 +369,73 @@
<span class="ruby-identifier">run_script</span>(<span class="ruby-identifier">file_path</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">self</span>
<span class="ruby-keyword">end</span></pre>
- </div><!-- define-source -->
+ </div>
</div>
- </div><!-- define-method -->
+ </div>
<div id="method-i-output_directory" class="method-detail ">
<div class="method-heading">
<span class="method-name">output_directory</span><span
class="method-args">()</span>
+
<span class="method-click-advice">click to toggle source</span>
+
</div>
<div class="method-description">
+
<div class="method-source-code" id="output_directory-source">
- <pre><span class="ruby-comment"># File lib/ruby-prof/task.rb, line 124</span>
+ <pre><span class="ruby-comment"># File lib/ruby-prof/task.rb, line 125</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">output_directory</span>
<span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-ivar">@output_dir</span>)
<span class="ruby-keyword">end</span></pre>
- </div><!-- output_directory-source -->
+ </div>
</div>
- </div><!-- output_directory-method -->
+ </div>
<div id="method-i-run_script" class="method-detail ">
<div class="method-heading">
<span class="method-name">run_script</span><span
class="method-args">(script_path)</span>
+
<span class="method-click-advice">click to toggle source</span>
+
</div>
<div class="method-description">
<p>Run script</p>
+
<div class="method-source-code" id="run_script-source">
- <pre><span class="ruby-comment"># File lib/ruby-prof/task.rb, line 89</span>
+ <pre><span class="ruby-comment"># File lib/ruby-prof/task.rb, line 90</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">run_script</span>(<span class="ruby-identifier">script_path</span>)
<span class="ruby-identifier">run_code</span> = <span class="ruby-string">''</span>
<span class="ruby-constant">RakeFileUtils</span>.<span class="ruby-identifier">verbose</span>(<span class="ruby-ivar">@verbose</span>) <span class="ruby-keyword">do</span>
<span class="ruby-identifier">file_name</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span>(<span class="ruby-identifier">script_path</span>, <span class="ruby-constant">File</span>.<span class="ruby-identifier">extname</span>(<span class="ruby-identifier">script_path</span>))
<span class="ruby-keyword">case</span> <span class="ruby-ivar">@printer</span>
@@ -505,28 +466,27 @@
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">puts</span> <span class="ruby-string">""</span>
<span class="ruby-identifier">puts</span> <span class="ruby-string">""</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
- </div><!-- run_script-source -->
+ </div>
</div>
- </div><!-- run_script-method -->
+ </div>
- </section><!-- public-instance-method-details -->
+ </section>
- </section><!-- 5Buntitled-5D -->
+ </section>
+</main>
-</div><!-- documentation -->
-
-<footer id="validator-badges">
- <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
- <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.1.
- <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
+<footer id="validator-badges" role="contentinfo">
+ <p><a href="http://validator.w3.org/check/referer">Validate</a>
+ <p>Generated by <a href="http://rdoc.rubyforge.org">RDoc</a> 4.1.0.
+ <p>Based on <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>