summaryrefslogtreecommitdiff
path: root/libpeas/peas-object-module.h
diff options
context:
space:
mode:
authorSteve Frécinaux <code@istique.net>2010-07-28 00:14:17 +0200
committerSteve Frécinaux <code@istique.net>2010-07-28 00:14:17 +0200
commitc13896e6539b4d4ecf232229a98a4cac5099612a (patch)
tree2ed13c4f62ac1e24e7da88d504cd0c5a38e26ad6 /libpeas/peas-object-module.h
parent328803d75766a1ca31e498d819120f8c452bb751 (diff)
downloadlibpeas-c13896e6539b4d4ecf232229a98a4cac5099612a.tar.gz
Update PeasObjectModule documentation.
Diffstat (limited to 'libpeas/peas-object-module.h')
-rw-r--r--libpeas/peas-object-module.h14
1 files changed, 14 insertions, 0 deletions
diff --git a/libpeas/peas-object-module.h b/libpeas/peas-object-module.h
index a87fd2d..ca29e69 100644
--- a/libpeas/peas-object-module.h
+++ b/libpeas/peas-object-module.h
@@ -41,10 +41,24 @@ typedef struct _PeasObjectModule PeasObjectModule;
typedef struct _PeasObjectModuleClass PeasObjectModuleClass;
typedef struct _PeasObjectModulePrivate PeasObjectModulePrivate;
+/**
+ * PeasFactoryFunc:
+ *
+ * A #PeasFactoryFunc is a factory function which will instanciate a new
+ * extension of a given type. g_object_newv() is such a function.
+ *
+ * It is used with peas_object_module_register_object_factory().
+ */
typedef GObject *(*PeasFactoryFunc) (guint n_parameters,
GParameter *parameters,
gpointer user_data);
+/**
+ * PeasObjectModule:
+ *
+ * The #PeasObjectModule structure contains only private data and should only
+ * be accessed using the provided API.
+ */
struct _PeasObjectModule {
GTypeModule parent;