In Files

  • rdoc/generator/ri.rb

Parent

Class/Module Index [+]

Quicksearch

RDoc::Generator::RI

Generates ri data files

Constants

DESCRIPTION

Description of this generator

Public Instance Methods

generate() click to toggle source

Writes the parsed data store to disk for use by ri.

 
               # File rdoc/generator/ri.rb, line 25
def generate
  @store.save
end
            

Protected Instance Methods

initialize(store, options) click to toggle source

Set up a new ri generator

 
               # File rdoc/generator/ri.rb, line 16
def initialize store, options #:not-new:
  @options    = options
  @store      = store
  @store.path = '.'
end
            

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit Documenting-ruby.org.

blog comments powered by Disqus