diff base/StorageAdviser.h @ 169:603991c63ff6

...

--- a/base/StorageAdviser.h	Mon Sep 25 13:44:05 2006 +0000
+++ b/base/StorageAdviser.h	Mon Sep 25 20:32:44 2006 +0000
@@ -39,9 +39,17 @@
         UseAsMuchAsYouLike = 8
     };
 
-    // may throw InsufficientDiscSpace exception if it looks like
-    // minimumSize won't fit on the disc
+    // May throw InsufficientDiscSpace exception if it looks like
+    // minimumSize won't fit on the disc.  
 
+    /**
+     * Recommend where to store some data, given certain storage and
+     * recall criteria.  The minimum size is the approximate amount of
+     * data in bytes that will be stored if the recommendation is to
+     * ConserveSpace; the maximum size is approximately the amount
+     * that will be used if UseAsMuchAsYouLike is returned.
+     **!!! sizes should be longer types
+     */
     static Recommendation recommend(Criteria criteria,
                                     int minimumSize,
                                     int maximumSize);