uobject: Add some descriptions of the loadable/exportable interfaces.

[upkg.git] / src / uobject / loadable.h

diff --git a/src/uobject/loadable.h b/src/uobject/loadable.h
index 90888e9b0703de18c9397481ff8af58bcd918fee..ff5fd6342da46fda7656516df3833253d39797b4 100644 (file)
--- a/src/uobject/loadable.h
+++ b/src/uobject/loadable.h
@@ -33,6 +33,12 @@
 
 typedef struct UObjectLoadable UObjectLoadable;
 
+/*
+ * Interface for UObjects supporting "load" and "unload".  These are generally
+ * objects that need to allocate large amounts of memory in order to be
+ * useful -- textures and sounds, for example -- where you might want to keep
+ * around instances but the actual texture or sound data is not needed.
+ */
 struct UObjectLoadable {
        GTypeInterface parent;