lib/rdoc/ri/store.rb in rdoc-3.5.3 vs lib/rdoc/ri/store.rb in rdoc-3.6

@@ -5,9 +5,21 @@
 # A set of ri data.
 #
 # The store manages reading and writing ri data for a project (gem, path,
 # etc.) 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 = {
+#      :class_methods    => {}, # class name => class methods
+#      :instance_methods => {}, # class name => instance methods
+#      :attributes       => {}, # class name => attributes
+#      :modules          => [], # classes and modules in this store
+#      :ancestors        => {}, # class name => ancestor names
+#    }
 
 class RDoc::RI::Store
 
   ##
   # If true this Store will not write any files