[libpeas] Update PeasObjectModule documentation.



commit c13896e6539b4d4ecf232229a98a4cac5099612a
Author: Steve Frécinaux <code istique net>
Date:   Wed Jul 28 00:14:17 2010 +0200

    Update PeasObjectModule documentation.

 libpeas/peas-object-module.h |   14 ++++++++++++++
 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;
 



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]