haxorqt
Home
Console
Upload
information
Create File
Create Folder
About
:
/
opt
/
alt
/
ruby27
/
share
/
ri
/
system
/
RDocTask
/
Filename :
cdesc-RDocTask.ri
back
Copy
U:RDoc::NormalClass[iI" RDocTask:ET@I"Rake::TaskLib;To:RDoc::Markup::Document: @parts[o;;[o: RDoc::Markup::Paragraph;[I"ORDoc::Task creates the following rake tasks to generate and clean up RDoc ;TI" output:;To: RDoc::Markup::BlankLine o:RDoc::Markup::List: @type: LABEL: @items[o:RDoc::Markup::ListItem: @label[I" rdoc;T;[o; ;[I""Main task for this RDoc task.;T@o;;[I"clobber_rdoc;T;[o; ;[I"PDelete all the rdoc files. This target is automatically added to the main ;TI"clobber target.;T@o;;[I" rerdoc;T;[o; ;[I"KRebuild the rdoc files from scratch, even if they are not out of date.;T@o; ;[I"Simple Example:;T@o:RDoc::Markup::Verbatim;[ I"require 'rdoc/task' ;TI" ;TI" RDoc::Task.new do |rdoc| ;TI"! rdoc.main = "README.rdoc" ;TI"= rdoc.rdoc_files.include("README.rdoc", "lib/**/*.rb") ;TI" end ;T: @format0o; ;[I"LThe +rdoc+ object passed to the block is an RDoc::Task object. See the ;TI"Rattributes list for the RDoc::Task class for available customization options.;T@S:RDoc::Markup::Heading: leveli: textI"$Specifying different task names;T@o; ;[I"HYou may wish to give the task a different name, such as if you are ;TI"Pgenerating two sets of documentation. For instance, if you want to have a ;TI"@development set of documentation including private methods:;T@o;;[ I"require 'rdoc/task' ;TI" ;TI"(RDoc::Task.new :rdoc_dev do |rdoc| ;TI" rdoc.main = "README.doc" ;TI"= rdoc.rdoc_files.include("README.rdoc", "lib/**/*.rb") ;TI" rdoc.options << "--all" ;TI" end ;T;0o; ;[I"7The tasks would then be named :<em>rdoc_dev</em>, ;TI"::clobber_<em>rdoc_dev</em>, and :re<em>rdoc_dev</em>.;T@o; ;[I"NIf you wish to have completely different task names, then pass a Hash as ;TI"Ifirst argument. With the <tt>:rdoc</tt>, <tt>:clobber_rdoc</tt> and ;TI"O<tt>:rerdoc</tt> options, you can customize the task names to your liking.;T@o; ;[I"For example:;T@o;;[ I"require 'rdoc/task' ;TI" ;TI"DRDoc::Task.new(:rdoc => "rdoc", :clobber_rdoc => "rdoc:clean", ;TI"- :rerdoc => "rdoc:force") ;T;0o; ;[I"IThis will create the tasks <tt>:rdoc</tt>, <tt>:rdoc:clean</tt> and ;TI"<tt>:rdoc:force</tt>.;T: @fileI"lib/rdoc/task.rb;T:0@omit_headings_from_table_of_contents_below0;0;0[[ I" external;TI"RW;T: privateFI"lib/rdoc/task.rb;T[ I"generator;T@c;F@d[ I" main;T@c;F@d[ I" markup;T@c;F@d[ I" name;T@c;F@d[ I" options;T@c;F@d[ I" rdoc_dir;T@c;F@d[ I"rdoc_files;T@c;F@d[ I" template;T@c;F@d[ I" title;T@c;F@d[ [ [[I" class;T[[: public[ [:protected[ [;[[I"new;T@d[I" instance;T[[;[ [;[ [;[[I"before_running_rdoc;T@d[I"check_names;T@d[I" clobber_task_description;T@d[I"clobber_task_name;T@d[I" defaults;T@d[I" define;T@d[I"option_list;T@d[I"rdoc_target;T@d[I"rdoc_task_description;T@d[I"rdoc_task_name;T@d[I" rerdoc_task_description;T@d[I"rerdoc_task_name;T@d[ [U:RDoc::Context::Section[i 0o;;[ ;0;0[I"lib/rdoc/task.rb;T@_cRDoc::TopLevel