D7net
Home
Console
Upload
information
Create File
Create Folder
About
Tools
:
/
proc
/
self
/
root
/
opt
/
alt
/
ruby34
/
share
/
ri
/
system
/
RDoc
/
Filename :
cdesc-RDoc.ri
back
Copy
U:RDoc::NormalClass[iI" RDoc:ET@I" Object;To:RDoc::Markup::Document: @parts[ o;;[*o: RDoc::Markup::Paragraph;[ I"QRDoc produces documentation for Ruby source files by parsing the source and ;TI"Kextracting the definition for classes, modules, methods, includes and ;TI"Prequires. It associates these with optional documentation contained in an ;TI"Qimmediately preceding comment block then renders the result using an output ;TI"formatter.;To: RDoc::Markup::BlankLine o; ;[I"QFor a simple introduction to writing or generating documentation using RDoc ;TI"see the README.;T@S:RDoc::Markup::Heading: leveli: textI" Roadmap;T@o; ;[I"?If you think you found a bug in RDoc see CONTRIBUTING@Bugs;T@o; ;[I"QIf you want to use RDoc to create documentation for your Ruby source files, ;TI"Osee RDoc::Markup and refer to <tt>rdoc --help</tt> for command line usage.;T@o; ;[I"6If you want to set the default markup format see ;TI" RDoc::Markup@Markup+Formats;T@o; ;[I"NIf you want to store rdoc configuration in your gem (such as the default ;TI"3markup format) see RDoc::Options@Saved+Options;T@o; ;[I"MIf you want to write documentation for Ruby files see RDoc::Parser::Ruby;T@o; ;[I"HIf you want to write documentation for extensions written in C see ;TI"RDoc::Parser::C;T@o; ;[I"NIf you want to generate documentation using <tt>rake</tt> see RDoc::Task.;T@o; ;[I"@If you want to drive RDoc programmatically, see RDoc::RDoc.;T@o; ;[I"MIf you want to use the library to format text blocks into HTML or other ;TI"#formats, look at RDoc::Markup.;T@o; ;[I"QIf you want to make an RDoc plugin such as a generator or directive handler ;TI"see RDoc::RDoc.;T@o; ;[I"HIf you want to write your own output generator see RDoc::Generator.;T@o; ;[I"?If you want an overview of how RDoc works see CONTRIBUTING;T@S; ; i; I" Credits;T@o; ;[I"MRDoc is currently being maintained by Eric Hodel <drbrain@segment7.net>.;T@o; ;[I"ODave Thomas <dave@pragmaticprogrammer.com> is the original author of RDoc.;T@o:RDoc::Markup::List: @type: BULLET: @items[o:RDoc::Markup::ListItem: @label0;[o; ;[I"JThe Ruby parser in rdoc/parse.rb is based heavily on the outstanding ;TI"Kwork of Keiju ISHITSUKA of Nippon Rational Inc, who produced the Ruby ;TI"*parser for irb and the rtags package.;T: @fileI"lib/rdoc.rb;T:0@omit_headings_from_table_of_contents_below0o;;[ ;I" lib/rdoc/known_classes.rb;T;0o;;[ o; ;[I"?This class is referenced by RubyGems to create documents. ;TI"=All implementations are moved to the above RubyGemsHook.;T@o; ;[I"IThis class does nothing when this RDoc is installed as a normal gem ;TI"or a bundled gem.;T@o; ;[I"FThis class does generate/remove documents for compatibility when ;TI"-this RDoc is installed as a default gem.;T@o; ;[I"<We can remove this when all maintained RubyGems remove ;TI"`rubygems/rdoc.rb`.;T;I" lib/rdoc/rubygems_hook.rb;T;0o;;[ ;I"lib/rdoc/version.rb;T;0;0;0[ [U:RDoc::Constant[i I"VISIBILITIES;TI"RDoc::VISIBILITIES;T: public0o;;[o; ;[I"Method visibilities;T;@V;0@V@cRDoc::NormalClass0U;[i I"DOT_DOC_FILENAME;TI"RDoc::DOT_DOC_FILENAME;T;0o;;[o; ;[I"PName of the dotfile that contains the description of files to be processed ;TI" in the current directory;T;@V;0@V@@{0U;[i I"GENERAL_MODIFIERS;TI" RDoc::GENERAL_MODIFIERS;T;0o;;[o; ;[I"General RDoc modifiers;T;@V;0@V@@{0U;[i I"CLASS_MODIFIERS;TI"RDoc::CLASS_MODIFIERS;T;0o;;[o; ;[I" RDoc modifiers for classes;T;@V;0@V@@{0U;[i I"ATTR_MODIFIERS;TI"RDoc::ATTR_MODIFIERS;T;0o;;[o; ;[I""RDoc modifiers for attributes;T;@V;0@V@@{0U;[i I"CONSTANT_MODIFIERS;TI" RDoc::CONSTANT_MODIFIERS;T;0o;;[o; ;[I"!RDoc modifiers for constants;T;@V;0@V@@{0U;[i I"METHOD_MODIFIERS;TI"RDoc::METHOD_MODIFIERS;T;0o;;[o; ;[I" RDoc modifiers for methods;T;@V;0@V@@{0U;[i I"KNOWN_CLASSES;TI"RDoc::KNOWN_CLASSES;T;0o;;[o; ;[I"4Ruby's built-in classes, modules and exceptions;T;@Y;0@Y@@{0U;[i I" VERSION;TI"RDoc::VERSION;T;0o;;[o; ;[I" RDoc version you are using;T;@o;0@o@@{0[ [[I" class;T[[;[ [:protected[ [: private[[I" home;TI"lib/rdoc.rb;T[I"load_yaml;T@�[I" instance;T[[;[ [;[ [;[ [ [U:RDoc::Context::Section[i 0o;;[ ;0;0[I" lib/rdoc/rubygems_hook.rb;T@ocRDoc::TopLevel