summaryrefslogtreecommitdiff
path: root/gobject/gtypeplugin.c
diff options
context:
space:
mode:
authorMatthias Clasen <mclasen@redhat.com>2014-02-01 10:19:07 -0500
committerMatthias Clasen <mclasen@redhat.com>2014-02-01 10:22:45 -0500
commit60b623d3fb70c09cb08e6c088b76c59d4316e132 (patch)
treec5c1a19c3b3c9916eedc223fe74d2ed1c817e7db /gobject/gtypeplugin.c
parentc93c05faa32aa030ff7aa604b5bb01871716cb2c (diff)
downloadglib-60b623d3fb70c09cb08e6c088b76c59d4316e132.tar.gz
GObject: Convert docs to markdown
In particular, convert lists to markdown syntax.
Diffstat (limited to 'gobject/gtypeplugin.c')
-rw-r--r--gobject/gtypeplugin.c71
1 files changed, 31 insertions, 40 deletions
diff --git a/gobject/gtypeplugin.c b/gobject/gtypeplugin.c
index 13fc98988..c29258cd3 100644
--- a/gobject/gtypeplugin.c
+++ b/gobject/gtypeplugin.c
@@ -26,49 +26,40 @@
* @see_also: #GTypeModule and g_type_register_dynamic().
* @title: GTypePlugin
*
- * The GObject type system supports dynamic loading of types. The
- * #GTypePlugin interface is used to handle the lifecycle of
- * dynamically loaded types. It goes as follows:
+ * The GObject type system supports dynamic loading of types.
+ * The #GTypePlugin interface is used to handle the lifecycle
+ * of dynamically loaded types. It goes as follows:
*
- * <orderedlist>
- * <listitem><para>
- * The type is initially introduced (usually upon loading the module
- * the first time, or by your main application that knows what modules
- * introduces what types), like this:
- * |[
- * new_type_id = g_type_register_dynamic (parent_type_id,
- * "TypeName",
- * new_type_plugin,
- * type_flags);
- * ]|
- * where <literal>new_type_plugin</literal> is an implementation of the
- * #GTypePlugin interface.
- * </para></listitem>
- * <listitem><para>
- * The type's implementation is referenced, e.g. through
+ * 1. The type is initially introduced (usually upon loading the module
+ * the first time, or by your main application that knows what modules
+ * introduces what types), like this:
+ * |[
+ * new_type_id = g_type_register_dynamic (parent_type_id,
+ * "TypeName",
+ * new_type_plugin,
+ * type_flags);
+ * ]|
+ * where @new_type_plugin is an implementation of the
+ * #GTypePlugin interface.
+ *
+ * 2. The type's implementation is referenced, e.g. through
* g_type_class_ref() or through g_type_create_instance() (this is
* being called by g_object_new()) or through one of the above done on
- * a type derived from <literal>new_type_id</literal>.
- * </para></listitem>
- * <listitem><para>
- * This causes the type system to load the type's implementation by calling
- * g_type_plugin_use() and g_type_plugin_complete_type_info() on
- * <literal>new_type_plugin</literal>.
- * </para></listitem>
- * <listitem><para>
- * At some point the type's implementation isn't required anymore, e.g. after
- * g_type_class_unref() or g_type_free_instance() (called when the reference
- * count of an instance drops to zero).
- * </para></listitem>
- * <listitem><para>
- * This causes the type system to throw away the information retrieved from
- * g_type_plugin_complete_type_info() and then it calls
- * g_type_plugin_unuse() on <literal>new_type_plugin</literal>.
- * </para></listitem>
- * <listitem><para>
- * Things may repeat from the second step.
- * </para></listitem>
- * </orderedlist>
+ * a type derived from @new_type_id.
+ *
+ * 3. This causes the type system to load the type's implementation by
+ * calling g_type_plugin_use() and g_type_plugin_complete_type_info()
+ * on @new_type_plugin.
+ *
+ * 4. At some point the type's implementation isn't required anymore,
+ * e.g. after g_type_class_unref() or g_type_free_instance() (called
+ * when the reference count of an instance drops to zero).
+ *
+ * 5. This causes the type system to throw away the information retrieved
+ * from g_type_plugin_complete_type_info() and then it calls
+ * g_type_plugin_unuse() on @new_type_plugin.
+ *
+ * 6. Things may repeat from the second step.
*
* So basically, you need to implement a #GTypePlugin type that
* carries a use_count, once use_count goes from zero to one, you need