Type:
Class

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:

1
2
3
4
5
6
7
8
@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
}
all_classes_and_modules
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Store

all_classes_and_modules() Instance Public methods Returns all classes and modules

2025-01-10 15:47:30
friendly_path
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Store

friendly_path() Instance Public methods Friendly rendition of path

2025-01-10 15:47:30
find_c_enclosure
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Store

find_c_enclosure(variable) Instance Public methods Finds the enclosure (namespace)

2025-01-10 15:47:30
load_class_data
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Store

load_class_data(klass_name) Instance Public methods Loads ri data for

2025-01-10 15:47:30
remove_nodoc
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Store

remove_nodoc(all_hash) Instance Public methods Removes from all_hash

2025-01-10 15:47:30