From 796e6bb50a87d4f506a3691d2060a61a8b3534aa Mon Sep 17 00:00:00 2001
From: Robert Osfield <robert@openscenegraph.com>
Date: Fri, 13 Aug 2004 13:46:47 +0000
Subject: [PATCH] Added docs for CacheObjectHints

---
 include/osgDB/Registry | 17 ++++++++++++++---
 1 file changed, 14 insertions(+), 3 deletions(-)

diff --git a/include/osgDB/Registry b/include/osgDB/Registry
index 0ca2dd7a1..02a5f8915 100644
--- a/include/osgDB/Registry
+++ b/include/osgDB/Registry
@@ -68,13 +68,24 @@ class OSGDB_EXPORT Registry : public osg::Referenced
 {
     public:
 
+        /// bit mask for setting up which object types get cached by readObject/Image/HeightField/Node(filename) calls
         enum CacheHintOptions
-        {
+        {   /// do not cache objects of any type
             CACHE_NONE          = 0,
+            
+            /// cache nodes loaded via readNode(filename)
             CACHE_NODES         = 1,
+            
+            /// cache images loaded via readImage(filename)
             CACHE_IMAGES        = 2,
-            CACHE_HEIGHTFIELDS  = 4,
-            CACHE_OBJECTS       = 8,
+             
+            /// cache heightfield loaded via readHeightField(filename)
+            CACHE_HEIGHTFIELDS  = 4, 
+            
+            /// cache objects loaded via readObject(filename)
+            CACHE_OBJECTS       = 8, 
+            
+            /// cache on all read*(filename) calls
             CACHE_ALL           = CACHE_NODES |
                                   CACHE_IMAGES |
                                   CACHE_HEIGHTFIELDS |