Current File : //opt/cpanel/ea-ruby24/root/usr/share/ri/system/RDoc/Generator/cdesc-Generator.ri
U:RDoc::NormalModule[iI"Generator:EFI"RDoc::Generator;T0o:RDoc::Markup::Document: @parts[o;;[o: RDoc::Markup::Paragraph;[ I"GRDoc uses generators to turn parsed source code in the form of an ;TI"ORDoc::CodeObject tree into some form of output. RDoc comes with the HTML ;TI"Bgenerator RDoc::Generator::Darkfish and an ri data generator ;TI"RDoc::Generator::RI.;To: RDoc::Markup::BlankLine S:RDoc::Markup::Heading:
leveli: textI" Registering a Generator;T@o; ;[I"RGenerators are registered by calling RDoc::RDoc.add_generator with the class ;TI"of the generator:;T@o:RDoc::Markup::Verbatim;[I""class My::Awesome::Generator
;TI"% RDoc::RDoc.add_generator self
;TI" end
;T: @format0S; ; i;
I" Adding Options to +rdoc+;T@o; ;[
I"QBefore option processing in +rdoc+, RDoc::Options will call ::setup_options ;TI"Oon the generator class with an RDoc::Options instance. The generator can ;TI"Ouse RDoc::Options#option_parser to add command-line options to the +rdoc+ ;TI"Qtool. See RDoc::Options@Custom+Options for an example and see OptionParser ;TI"'for details on how to add options.;T@o; ;[I"RYou can extend the RDoc::Options instance with additional accessors for your ;TI"generator.;T@S; ; i;
I" Generator Instantiation;T@o; ;[I"GAfter parsing, RDoc::RDoc will instantiate a generator by calling ;TI"L#initialize with an RDoc::Store instance and an RDoc::Options instance.;T@o; ;[ I"NThe RDoc::Store instance holds documentation for parsed source code. In ;TI"QRDoc 3 and earlier the RDoc::TopLevel class held this data. When upgrading ;TI"Ia generator from RDoc 3 and earlier you should only need to replace ;TI",RDoc::TopLevel with the store instance.;T@o; ;[I"ORDoc will then call #generate on the generator instance. You can use the ;TI"Ovarious methods on RDoc::Store and in the RDoc::CodeObject tree to create ;TI" your desired output format.;T:
@fileI"lib/rdoc/generator.rb;T:0@omit_headings_from_table_of_contents_below0;0;0[ [ [ [[I"
class;T[[: public[ [:protected[ [: private[ [I"
instance;T[[;[ [;[ [;[ [ [U:RDoc::Context::Section[i 0o;;[ ;0;0[@=I"lib/rdoc/options.rb;TI"lib/rdoc/servlet.rb;TI" RDoc;FcRDoc::NormalModule
Mini Shell