File: C:/Ruby27-x64/share/doc/ruby/html/RDocTask.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class RDocTask - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "./";
var index_rel_prefix = "./";
</script>
<script src="./js/navigation.js" defer></script>
<script src="./js/search.js" defer></script>
<script src="./js/search_index.js" defer></script>
<script src="./js/searcher.js" defer></script>
<script src="./js/darkfish.js" defer></script>
<link href="./css/fonts.css" rel="stylesheet">
<link href="./css/rdoc.css" rel="stylesheet">
<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>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<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">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link">Rake::TaskLib
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-before_running_rdoc">#before_running_rdoc</a>
<li ><a href="#method-i-check_names">#check_names</a>
<li ><a href="#method-i-clobber_task_description">#clobber_task_description</a>
<li ><a href="#method-i-clobber_task_name">#clobber_task_name</a>
<li ><a href="#method-i-defaults">#defaults</a>
<li ><a href="#method-i-define">#define</a>
<li ><a href="#method-i-option_list">#option_list</a>
<li ><a href="#method-i-rdoc_target">#rdoc_target</a>
<li ><a href="#method-i-rdoc_task_description">#rdoc_task_description</a>
<li ><a href="#method-i-rdoc_task_name">#rdoc_task_name</a>
<li ><a href="#method-i-rerdoc_task_description">#rerdoc_task_description</a>
<li ><a href="#method-i-rerdoc_task_name">#rerdoc_task_name</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-RDocTask">
<h1 id="class-RDocTask" class="class">
class RDocTask
</h1>
<section class="description">
<p><a href="RDoc/Task.html"><code>RDoc::Task</code></a> creates the following rake tasks to generate and clean up <a href="RDoc.html"><code>RDoc</code></a> output:</p>
<dl class="rdoc-list label-list"><dt>rdoc
<dd>
<p>Main task for this <a href="RDoc.html"><code>RDoc</code></a> task.</p>
</dd><dt>clobber_rdoc
<dd>
<p>Delete all the rdoc files. This target is automatically added to the main clobber target.</p>
</dd><dt>rerdoc
<dd>
<p>Rebuild the rdoc files from scratch, even if they are not out of date.</p>
</dd></dl>
<p>Simple Example:</p>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'rdoc/task'</span>
<span class="ruby-constant">RDoc</span><span class="ruby-operator">::</span><span class="ruby-constant">Task</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">rdoc</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">rdoc</span>.<span class="ruby-identifier">main</span> = <span class="ruby-string">"README.rdoc"</span>
<span class="ruby-identifier">rdoc</span>.<span class="ruby-identifier">rdoc_files</span>.<span class="ruby-identifier">include</span>(<span class="ruby-string">"README.rdoc"</span>, <span class="ruby-string">"lib/**/*.rb"</span>)
<span class="ruby-keyword">end</span>
</pre>
<p>The <code>rdoc</code> object passed to the block is an <a href="RDoc/Task.html"><code>RDoc::Task</code></a> object. See the attributes list for the <a href="RDoc/Task.html"><code>RDoc::Task</code></a> class for available customization options.</p>
<h2 id="class-RDocTask-label-Specifying+different+task+names">Specifying different task names<span><a href="#class-RDocTask-label-Specifying+different+task+names">¶</a> <a href="#top">↑</a></span></h2>
<p>You may wish to give the task a different name, such as if you are generating two sets of documentation. For instance, if you want to have a development set of documentation including private methods:</p>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'rdoc/task'</span>
<span class="ruby-constant">RDoc</span><span class="ruby-operator">::</span><span class="ruby-constant">Task</span>.<span class="ruby-identifier">new</span> <span class="ruby-value">:rdoc_dev</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">rdoc</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">rdoc</span>.<span class="ruby-identifier">main</span> = <span class="ruby-string">"README.doc"</span>
<span class="ruby-identifier">rdoc</span>.<span class="ruby-identifier">rdoc_files</span>.<span class="ruby-identifier">include</span>(<span class="ruby-string">"README.rdoc"</span>, <span class="ruby-string">"lib/**/*.rb"</span>)
<span class="ruby-identifier">rdoc</span>.<span class="ruby-identifier">options</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"--all"</span>
<span class="ruby-keyword">end</span>
</pre>
<p>The tasks would then be named :<em>rdoc_dev</em>, :clobber_<em>rdoc_dev</em>, and :re<em>rdoc_dev</em>.</p>
<p>If you wish to have completely different task names, then pass a <a href="Hash.html"><code>Hash</code></a> as first argument. With the <code>:rdoc</code>, <code>:clobber_rdoc</code> and <code>:rerdoc</code> options, you can customize the task names to your liking.</p>
<p>For example:</p>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'rdoc/task'</span>
<span class="ruby-constant">RDoc</span><span class="ruby-operator">::</span><span class="ruby-constant">Task</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">:rdoc</span> <span class="ruby-operator">=></span> <span class="ruby-string">"rdoc"</span>, <span class="ruby-value">:clobber_rdoc</span> <span class="ruby-operator">=></span> <span class="ruby-string">"rdoc:clean"</span>,
<span class="ruby-value">:rerdoc</span> <span class="ruby-operator">=></span> <span class="ruby-string">"rdoc:force"</span>)
</pre>
<p>This will create the tasks <code>:rdoc</code>, <code>:rdoc:clean</code> and <code>:rdoc:force</code>.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-external" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">external</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>Whether to run the rdoc process as an external shell (default is false)</p>
</div>
</div>
<div id="attribute-i-generator" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">generator</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>Name of format generator (<code>--format</code>) used by rdoc. (defaults to rdoc's default)</p>
</div>
</div>
<div id="attribute-i-main" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">main</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>Name of file to be used as the main, top level file of the <a href="../RDoc.html"><code>RDoc</code></a>. (default is none)</p>
</div>
</div>
<div id="attribute-i-markup" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">markup</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>Comment markup format. rdoc, rd and tomdoc are supported. (default is 'rdoc')</p>
</div>
</div>
<div id="attribute-i-name" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">name</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>Name of the main, top level task. (default is :rdoc)</p>
</div>
</div>
<div id="attribute-i-options" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">options</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>Additional list of options to be passed rdoc. (default is [])</p>
</div>
</div>
<div id="attribute-i-rdoc_dir" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">rdoc_dir</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>Name of directory to receive the html output files. (default is “html”)</p>
</div>
</div>
<div id="attribute-i-rdoc_files" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">rdoc_files</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>List of files to be included in the rdoc generation. (default is [])</p>
</div>
</div>
<div id="attribute-i-template" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">template</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>Name of template to be used by rdoc. (defaults to rdoc's default)</p>
</div>
</div>
<div id="attribute-i-title" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">title</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>Title of <a href="../RDoc.html"><code>RDoc</code></a> documentation. (defaults to rdoc's default)</p>
</div>
</div>
</section>
<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 = :rdoc) { |self| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Create an <a href="../RDoc.html"><code>RDoc</code></a> task with the given name. See the <a href="Task.html"><code>RDoc::Task</code></a> class overview for documentation.</p>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/rdoc/task.rb, line 155</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span> <span class="ruby-identifier">name</span> = <span class="ruby-value">:rdoc</span> <span class="ruby-comment"># :yield: self</span>
<span class="ruby-identifier">defaults</span>
<span class="ruby-identifier">check_names</span> <span class="ruby-identifier">name</span>
<span class="ruby-ivar">@name</span> = <span class="ruby-identifier">name</span>
<span class="ruby-keyword">yield</span> <span class="ruby-keyword">self</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
<span class="ruby-identifier">define</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-before_running_rdoc" class="method-detail ">
<div class="method-heading">
<span class="method-name">before_running_rdoc</span><span
class="method-args">(&block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>The block passed to this method will be called just before running the <a href="../RDoc.html"><code>RDoc</code></a> generator. It is allowed to modify <a href="Task.html"><code>RDoc::Task</code></a> attributes inside the block.</p>
<div class="method-source-code" id="before_running_rdoc-source">
<pre><span class="ruby-comment"># File lib/rdoc/task.rb, line 273</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">before_running_rdoc</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-ivar">@before_running_rdoc</span> = <span class="ruby-identifier">block</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-check_names" class="method-detail ">
<div class="method-heading">
<span class="method-name">check_names</span><span
class="method-args">(names)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Ensures that <code>names</code> only includes names for the :rdoc, :clobber_rdoc and :rerdoc. If other names are given an <a href="../ArgumentError.html"><code>ArgumentError</code></a> is raised.</p>
<div class="method-source-code" id="check_names-source">
<pre><span class="ruby-comment"># File lib/rdoc/task.rb, line 171</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">check_names</span> <span class="ruby-identifier">names</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">unless</span> <span class="ruby-constant">Hash</span> <span class="ruby-operator">===</span> <span class="ruby-identifier">names</span>
<span class="ruby-identifier">invalid_options</span> =
<span class="ruby-identifier">names</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">k</span><span class="ruby-operator">|</span> <span class="ruby-identifier">k</span>.<span class="ruby-identifier">to_sym</span> } <span class="ruby-operator">-</span> [<span class="ruby-value">:rdoc</span>, <span class="ruby-value">:clobber_rdoc</span>, <span class="ruby-value">:rerdoc</span>]
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">invalid_options</span>.<span class="ruby-identifier">empty?</span> <span class="ruby-keyword">then</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-node">"invalid options: #{invalid_options.join ', '}"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-clobber_task_description" class="method-detail ">
<div class="method-heading">
<span class="method-name">clobber_task_description</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p><a href="Task.html"><code>Task</code></a> description for the clobber rdoc task or its renamed equivalent</p>
<div class="method-source-code" id="clobber_task_description-source">
<pre><span class="ruby-comment"># File lib/rdoc/task.rb, line 185</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">clobber_task_description</span>
<span class="ruby-string">"Remove RDoc HTML files"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-defaults" class="method-detail ">
<div class="method-heading">
<span class="method-name">defaults</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sets default task values</p>
<div class="method-source-code" id="defaults-source">
<pre><span class="ruby-comment"># File lib/rdoc/task.rb, line 192</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">defaults</span>
<span class="ruby-ivar">@name</span> = <span class="ruby-value">:rdoc</span>
<span class="ruby-ivar">@rdoc_files</span> = <span class="ruby-constant">Rake</span><span class="ruby-operator">::</span><span class="ruby-constant">FileList</span>.<span class="ruby-identifier">new</span>
<span class="ruby-ivar">@rdoc_dir</span> = <span class="ruby-string">'html'</span>
<span class="ruby-ivar">@main</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@title</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@template</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@generator</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@options</span> = []
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</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/rdoc/task.rb, line 221</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">define</span>
<span class="ruby-identifier">desc</span> <span class="ruby-identifier">rdoc_task_description</span>
<span class="ruby-identifier">task</span> <span class="ruby-identifier">rdoc_task_name</span>
<span class="ruby-identifier">desc</span> <span class="ruby-identifier">rerdoc_task_description</span>
<span class="ruby-identifier">task</span> <span class="ruby-identifier">rerdoc_task_name</span> <span class="ruby-operator">=></span> [<span class="ruby-identifier">clobber_task_name</span>, <span class="ruby-identifier">rdoc_task_name</span>]
<span class="ruby-identifier">desc</span> <span class="ruby-identifier">clobber_task_description</span>
<span class="ruby-identifier">task</span> <span class="ruby-identifier">clobber_task_name</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">rm_r</span> <span class="ruby-ivar">@rdoc_dir</span> <span class="ruby-keyword">rescue</span> <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">task</span> <span class="ruby-value">:clobber</span> <span class="ruby-operator">=></span> [<span class="ruby-identifier">clobber_task_name</span>]
<span class="ruby-identifier">directory</span> <span class="ruby-ivar">@rdoc_dir</span>
<span class="ruby-identifier">rdoc_target_deps</span> = [
<span class="ruby-ivar">@rdoc_files</span>,
<span class="ruby-constant">Rake</span>.<span class="ruby-identifier">application</span>.<span class="ruby-identifier">rakefile</span>
].<span class="ruby-identifier">flatten</span>.<span class="ruby-identifier">compact</span>
<span class="ruby-identifier">task</span> <span class="ruby-identifier">rdoc_task_name</span> <span class="ruby-operator">=></span> [<span class="ruby-identifier">rdoc_target</span>]
<span class="ruby-identifier">file</span> <span class="ruby-identifier">rdoc_target</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">rdoc_target_deps</span> <span class="ruby-keyword">do</span>
<span class="ruby-ivar">@before_running_rdoc</span>.<span class="ruby-identifier">call</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@before_running_rdoc</span>
<span class="ruby-identifier">args</span> = <span class="ruby-identifier">option_list</span> <span class="ruby-operator">+</span> <span class="ruby-ivar">@rdoc_files</span>
<span class="ruby-identifier">$stderr</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">"rdoc #{args.join ' '}"</span> <span class="ruby-keyword">if</span> <span class="ruby-constant">Rake</span>.<span class="ruby-identifier">application</span>.<span class="ruby-identifier">options</span>.<span class="ruby-identifier">trace</span>
<span class="ruby-constant">RDoc</span><span class="ruby-operator">::</span><span class="ruby-constant">RDoc</span>.<span class="ruby-identifier">new</span>.<span class="ruby-identifier">document</span> <span class="ruby-identifier">args</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">self</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-option_list" class="method-detail ">
<div class="method-heading">
<span class="method-name">option_list</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>List of options that will be supplied to <a href="../RDoc.html"><code>RDoc</code></a></p>
<div class="method-source-code" id="option_list-source">
<pre><span class="ruby-comment"># File lib/rdoc/task.rb, line 257</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">option_list</span>
<span class="ruby-identifier">result</span> = <span class="ruby-ivar">@options</span>.<span class="ruby-identifier">dup</span>
<span class="ruby-identifier">result</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"-o"</span> <span class="ruby-operator"><<</span> <span class="ruby-ivar">@rdoc_dir</span>
<span class="ruby-identifier">result</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"--main"</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">main</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">main</span>
<span class="ruby-identifier">result</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"--markup"</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">markup</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">markup</span>
<span class="ruby-identifier">result</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"--title"</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">title</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">title</span>
<span class="ruby-identifier">result</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"-T"</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">template</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">template</span>
<span class="ruby-identifier">result</span> <span class="ruby-operator"><<</span> <span class="ruby-string">'-f'</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">generator</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">generator</span>
<span class="ruby-identifier">result</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-rdoc_task_description" class="method-detail ">
<div class="method-heading">
<span class="method-name">rdoc_task_description</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p><a href="Task.html"><code>Task</code></a> description for the rdoc task or its renamed equivalent</p>
<div class="method-source-code" id="rdoc_task_description-source">
<pre><span class="ruby-comment"># File lib/rdoc/task.rb, line 280</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">rdoc_task_description</span>
<span class="ruby-string">'Build RDoc HTML files'</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-rerdoc_task_description" class="method-detail ">
<div class="method-heading">
<span class="method-name">rerdoc_task_description</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p><a href="Task.html"><code>Task</code></a> description for the rerdoc task or its renamed description</p>
<div class="method-source-code" id="rerdoc_task_description-source">
<pre><span class="ruby-comment"># File lib/rdoc/task.rb, line 287</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">rerdoc_task_description</span>
<span class="ruby-string">"Rebuild RDoc HTML files"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="private-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Private Instance Methods</h3>
</header>
<div id="method-i-clobber_task_name" class="method-detail ">
<div class="method-heading">
<span class="method-name">clobber_task_name</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="clobber_task_name-source">
<pre><span class="ruby-comment"># File lib/rdoc/task.rb, line 304</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">clobber_task_name</span>
<span class="ruby-keyword">case</span> <span class="ruby-identifier">name</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">Hash</span> <span class="ruby-keyword">then</span> (<span class="ruby-identifier">name</span>[<span class="ruby-value">:clobber_rdoc</span>] <span class="ruby-operator">||</span> <span class="ruby-string">"clobber_rdoc"</span>).<span class="ruby-identifier">to_s</span>
<span class="ruby-keyword">else</span> <span class="ruby-node">"clobber_#{name}"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-rdoc_target" class="method-detail ">
<div class="method-heading">
<span class="method-name">rdoc_target</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="rdoc_target-source">
<pre><span class="ruby-comment"># File lib/rdoc/task.rb, line 293</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">rdoc_target</span>
<span class="ruby-node">"#{rdoc_dir}/created.rid"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-rdoc_task_name" class="method-detail ">
<div class="method-heading">
<span class="method-name">rdoc_task_name</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="rdoc_task_name-source">
<pre><span class="ruby-comment"># File lib/rdoc/task.rb, line 297</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">rdoc_task_name</span>
<span class="ruby-keyword">case</span> <span class="ruby-identifier">name</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">Hash</span> <span class="ruby-keyword">then</span> (<span class="ruby-identifier">name</span>[<span class="ruby-value">:rdoc</span>] <span class="ruby-operator">||</span> <span class="ruby-string">"rdoc"</span>).<span class="ruby-identifier">to_s</span>
<span class="ruby-keyword">else</span> <span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_s</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-rerdoc_task_name" class="method-detail ">
<div class="method-heading">
<span class="method-name">rerdoc_task_name</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="rerdoc_task_name-source">
<pre><span class="ruby-comment"># File lib/rdoc/task.rb, line 311</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">rerdoc_task_name</span>
<span class="ruby-keyword">case</span> <span class="ruby-identifier">name</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">Hash</span> <span class="ruby-keyword">then</span> (<span class="ruby-identifier">name</span>[<span class="ruby-value">:rerdoc</span>] <span class="ruby-operator">||</span> <span class="ruby-string">"rerdoc"</span>).<span class="ruby-identifier">to_s</span>
<span class="ruby-keyword">else</span> <span class="ruby-node">"re#{name}"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>