Merge remote-tracking branch 'gvdb/master'

[platform/upstream/glib.git] / gobject / gtypeplugin.h

diff --git a/gobject/gtypeplugin.h b/gobject/gtypeplugin.h
index 380dd32..ff87a70 100644 (file)
--- a/gobject/gtypeplugin.h
+++ b/gobject/gtypeplugin.h
@@ -16,18 +16,16 @@
  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  * Boston, MA 02111-1307, USA.
  */
+#if !defined (__GLIB_GOBJECT_H_INSIDE__) && !defined (GOBJECT_COMPILATION)
+#error "Only <glib-object.h> can be included directly."
+#endif
+
 #ifndef __G_TYPE_PLUGIN_H__
 #define __G_TYPE_PLUGIN_H__
 
-
 #include       <gobject/gtype.h>
 
-
-#ifdef __cplusplus
-extern "C" {
-#endif /* __cplusplus */
-
-
+G_BEGIN_DECLS
 
 /* --- type macros --- */
 #define G_TYPE_TYPE_PLUGIN             (g_type_plugin_get_type ())
@@ -40,20 +38,77 @@ extern "C" {
 
 /* --- typedefs & structures --- */
 typedef struct _GTypePluginClass                  GTypePluginClass;
+/**
+ * GTypePluginUse:
+ * @plugin: the #GTypePlugin whose use count should be increased
+ * 
+ * The type of the @use_plugin function of #GTypePluginClass, which gets called
+ * to increase the use count of @plugin.
+ */
 typedef void  (*GTypePluginUse)                          (GTypePlugin     *plugin);
+/**
+ * GTypePluginUnuse:
+ * @plugin: the #GTypePlugin whose use count should be decreased
+ * 
+ * The type of the @unuse_plugin function of #GTypePluginClass.
+ */
 typedef void  (*GTypePluginUnuse)                (GTypePlugin     *plugin);
+/**
+ * GTypePluginCompleteTypeInfo:
+ * @plugin: the #GTypePlugin
+ * @g_type: the #GType whose info is completed
+ * @info: the #GTypeInfo struct to fill in
+ * @value_table: the #GTypeValueTable to fill in
+ * 
+ * The type of the @complete_type_info function of #GTypePluginClass.
+ */
 typedef void  (*GTypePluginCompleteTypeInfo)     (GTypePlugin     *plugin,
                                                   GType            g_type,
                                                   GTypeInfo       *info,
                                                   GTypeValueTable *value_table);
+/**
+ * GTypePluginCompleteInterfaceInfo:
+ * @plugin: the #GTypePlugin
+ * @instance_type: the #GType of an instantiable type to which the interface
+ *  is added
+ * @interface_type: the #GType of the interface whose info is completed
+ * @info: the #GInterfaceInfo to fill in
+ * 
+ * The type of the @complete_interface_info function of #GTypePluginClass.
+ */
 typedef void  (*GTypePluginCompleteInterfaceInfo) (GTypePlugin     *plugin,
-                                                  GType            interface_type,
                                                   GType            instance_type,
+                                                  GType            interface_type,
                                                   GInterfaceInfo  *info);
+/**
+ * GTypePlugin:
+ * 
+ * The <structname>GTypePlugin</structname> typedef is used as a placeholder 
+ * for objects that implement the <structname>GTypePlugin</structname> 
+ * interface.
+ */
+/**
+ * GTypePluginClass:
+ * @use_plugin: Increases the use count of the plugin.
+ * @unuse_plugin: Decreases the use count of the plugin.
+ * @complete_type_info: Fills in the #GTypeInfo and 
+ *  #GTypeValueTable structs for the type. The structs are initialized
+ *  with <literal>memset(s, 0, sizeof (s))</literal> before calling 
+ *  this function.
+ * @complete_interface_info: Fills in missing parts of the #GInterfaceInfo 
+ *  for the interface. The structs is initialized with 
+ *  <literal>memset(s, 0, sizeof (s))</literal> before calling
+ *  this function.
+ * 
+ * The #GTypePlugin interface is used by the type system in order to handle
+ * the lifecycle of dynamically loaded types.
+ */
 struct _GTypePluginClass
 {
+  /*< private >*/
   GTypeInterface                  base_iface;
   
+  /*< public >*/
   GTypePluginUse                  use_plugin;
   GTypePluginUnuse                unuse_plugin;
   GTypePluginCompleteTypeInfo     complete_type_info;
@@ -70,16 +125,10 @@ void       g_type_plugin_complete_type_info        (GTypePlugin     *plugin,
                                                 GTypeInfo       *info,
                                                 GTypeValueTable *value_table);
 void   g_type_plugin_complete_interface_info   (GTypePlugin     *plugin,
-                                                GType            interface_type,
                                                 GType            instance_type,
+                                                GType            interface_type,
                                                 GInterfaceInfo  *info);
 
-
-
-
-
-#ifdef __cplusplus
-}
-#endif /* __cplusplus */
+G_END_DECLS
 
 #endif /* __G_TYPE_PLUGIN_H__ */