Comment improvements

[libs/datafile.git] / source / collection.h

diff --git a/source/collection.h b/source/collection.h
index 0d2dc6be2fd7a6c4043ff4db18bfdc32a04bb270..7a09f5047d501dc0d361744b25c3714b36a5409a 100644 (file)
--- a/source/collection.h
+++ b/source/collection.h
@@ -46,8 +46,8 @@ method for details.
 Collections can have sources for loading objects on demand.  Automatic loading
 only works on a non-const Collection.  See class CollectionSource for details.
 
-A fallback collection can be designated as another way of loading items that
-are not present.  Items retrieted from the fallback collection are shared
+As a last resort, a fallback collection can be designated for loading items
+that are not present.  Items retrieted from the fallback collection are shared
 between the collections, and are only deleted when all collections in the chain
 have been destroyed.
 */
@@ -262,8 +262,13 @@ private:
        CollectionItemTypeBase *get_type_for_item(const Variant &) const;
 
 protected:
+       /** Adds a source for automatically loading items.  Sources are consulted
+       in the order they are added. */
        void add_source(CollectionSource &);
 
+       /** Opens a raw resource, without interpreting it as object data.  Null is
+       returned if no such file is found.  The caller must dispose of the returned
+       object when done with it. */
        IO::Seekable *open_from_sources(const std::string &);
 
 private: