class

RDoc::Store

v2_1_10 - Show latest stable - Superclass: Object

A set of rdoc data for a single project (gem, path, etc.).

The store manages reading and writing ri data for a project and maintains a cache of methods, classes and ancestors in the store.

The store maintains a #cache of its contents for faster lookup. After adding items to the store it must be flushed using #save_cache. The cache contains the following structures:

@cache = {
  :ancestors        => {}, # class name => ancestor names
  :attributes       => {}, # class name => attributes
  :class_methods    => {}, # class name => class methods
  :instance_methods => {}, # class name => instance methods
  :modules          => [], # classes and modules in this store
  :pages            => [], # page names
}

Attributes

[R]c_class_variables
[R]c_enclosure_classes
[R]c_enclosure_names
[R]c_singleton_class_variables
[R]cache
[RW]dry_run
[RW]encoding
[RW]path
[RW]rdoc
[RW]type

Files

  • lib/rdoc/store.rb