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
}
make_variable_map
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Store

make_variable_map(variables) Instance Public methods Converts the variable =>

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

load_page(page_name) Instance Public methods Loads ri data for page_name

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

add_c_variables(c_parser) Instance Public methods Adds

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

class_path(klass_name) Instance Public methods Path where data for klass_name

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

find_class_named(name) Instance Public methods Finds the class with name

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

complete(min_visibility) Instance Public methods Prepares the

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

module_names() Instance Public methods Modules cache accessor. An Array of

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

save_page(page) Instance Public methods Writes the ri data for page

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

new(path = nil, type = nil) Class Public methods Creates a new

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

unique_modules() Instance Public methods Returns the unique modules discovered

2025-01-10 15:47:30