Comment improvements

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

diff --git a/source/collectionsource.h b/source/collectionsource.h
index 90c36f2fce009768874c42b56c21fbf29d11457d..e5647d8231449f2793703eaea083876fd8b0f705 100644 (file)
--- a/source/collectionsource.h
+++ b/source/collectionsource.h
@@ -25,17 +25,18 @@ protected:
 public:
        virtual ~CollectionSource() { }
 
-       /** Determines */
+       /// Determines whether an object is available from this source.
        virtual bool is_loadable(const CollectionItemTypeBase &type, const std::string &name) const = 0;
 
-       /** Returns the names of loadable objects of a specific type.  Implementors
-       should use the keyword and/or suffixes of the type to  */
+       /** Returns the names of available objects of a specific type.  Implementors
+       should use type.match_name to check which names are acceptable. */
        virtual NameList get_names(const CollectionItemTypeBase &type) const = 0;
 
+       /// Loads an item into a collection.
        virtual void load(Collection &, const CollectionItemTypeBase &, const std::string &) const = 0;
 
-       /** Opens a file from the source.  The caller is responsible for deleting
-       the returned object when done with it. */
+       /** Opens a raw resource.  The caller is responsible for deleting the
+       returned object when done with it. */
        virtual IO::Seekable *open(const std::string &) const = 0;
 };