GuiPainter.cpp: correct attempt from r35491

[lyx.git] / src / Buffer.h

diff --git a/src/Buffer.h b/src/Buffer.h
index d1a591af0614bcba3210abd8a80a9725ed3be459..add05579cc0ec37442ead719347ed8b9056c3648 100644 (file)
--- a/src/Buffer.h
+++ b/src/Buffer.h
@@ -342,8 +342,20 @@ public:
        */
        void validate(LaTeXFeatures &) const;
 
-       /// Information from BibTeX databases is cached in the Buffer, so
-       /// we do not have to read the file over and over. 
+       /// Reference information is cached in the Buffer, so we do not
+       /// have to check or read things over and over. 
+       ///
+       /// There are two caches.
+       ///
+       /// One is a cache of the BibTeX files from which reference info is
+       /// being gathered. This cache is PER BUFFER, and the cache for the
+       /// master essentially includes the cache for its children. This gets
+       /// invalidated when an InsetBibtex is created, deleted, or modified.
+       /// 
+       /// The other is a cache of the reference information itself. This
+       /// exists only in the master buffer, and when it needs to be updated,
+       /// the children add their information to the master's cache.
+       
        /// Calling this method invalidates the cache and so requires a
        /// re-read.
        void invalidateBibinfoCache() const;