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

modules_hash() Instance Public methods

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

find_unique(all_hash) Instance Public methods Finds unique classes/modules defined

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

cache_path() Instance Public methods Path to the cache file

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

main() Instance Public methods Gets the main page for this

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

title() Instance Public methods Gets the title for this

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

save_cache() Instance Public methods Writes the cache file for this store

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

load_cache() Instance Public methods Loads cache file for this store

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

ancestors() Instance Public methods Ancestors cache accessor. Maps a klass

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

save() Instance Public methods Saves all entries in the store

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

unique_classes() Instance Public methods Returns the unique classes discovered

2025-01-10 15:47:30