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

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

diff --git a/src/uobject/exportable.h b/src/uobject/exportable.h
index 931d5b94a4010895b8d870d3090419837d7be0ef..6aa58b37a4b222ad71478c2355a1b71b384ab16d 100644 (file)
--- a/src/uobject/exportable.h
+++ b/src/uobject/exportable.h
@@ -33,6 +33,10 @@
 
 typedef struct UObjectExportable UObjectExportable;
 
+/*
+ * Interface for UObjects that support exporting to a file.  For example, a
+ * texture might be saved to disk as a PNG image for editing.
+ */
 struct UObjectExportable {
        GTypeInterface parent;
 
@@ -42,7 +46,19 @@ struct UObjectExportable {
 
 GType uobject_exportable_get_type(void);
 
+/*
+ * Export the object by writing it to the given FILE handle, which must have
+ * been opened for writing in binary mode.
+ */
 int uobject_export(GObject *obj, FILE *f);
+
+/*
+ * Get the suggested output filename.  Not more than n-1 characters of the
+ * filename will be written to buf, and the result is always null terminated.
+ * Returns the number of characters that would be written if the buffer was
+ * not bounded.  It is valid to call this function with a NULL buffer and a 0
+ * size in order to determine how large the buffer needs to be.
+ */
 int uobject_export_name(GObject *obj, char *buf, size_t n);
 
 #endif