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

attributes() Instance Public methods Attributes cache accessor. Maps a class

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

find_file_named(name) Instance Public methods Finds the file with name

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

main=(page) Instance Public methods Sets the main page for this

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

new(store, file, name) Class Public methods Creates a new

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

page_file(page_name) Instance Public methods Path to the ri data for

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

save_method(klass, method) Instance Public methods Writes the ri data for method

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

page(name) Instance Public methods Returns the

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

load_all() Instance Public methods Loads all items from this store into memory

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

find_text_page(file_name) Instance Public methods Returns the

2025-01-10 15:47:30