[glib] Some more doc cleanups
- From: Matthias Clasen <matthiasc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glib] Some more doc cleanups
- Date: Fri, 26 Mar 2010 14:31:20 +0000 (UTC)
commit 81e2aa941bbfd02bf1b6235da12834d282ceda0c
Author: Matthias Clasen <mclasen redhat com>
Date: Fri Mar 26 10:11:46 2010 -0400
Some more doc cleanups
docs/reference/gio/gio-sections.txt | 2 +
docs/reference/gobject/gobject-sections.txt | 2 +-
docs/reference/gobject/tmpl/gobject-unused.sgml | 9 +++++
gobject/gtype.c | 37 +++-------------------
4 files changed, 17 insertions(+), 33 deletions(-)
---
diff --git a/docs/reference/gio/gio-sections.txt b/docs/reference/gio/gio-sections.txt
index 9577083..63943b5 100644
--- a/docs/reference/gio/gio-sections.txt
+++ b/docs/reference/gio/gio-sections.txt
@@ -2066,6 +2066,8 @@ g_zlib_decompressor_get_type
<TITLE>GFileDescriptorBased</TITLE>
GFileDescriptorBased
g_file_descriptor_based_get_fd
+<SUBSECTION Standard>
+GFileDescriptorBaseIFace
<SUBSECTION Private>
g_file_descriptor_based_get_type
G_FILE_DESCRIPTOR_BASED
diff --git a/docs/reference/gobject/gobject-sections.txt b/docs/reference/gobject/gobject-sections.txt
index 5ffe394..58bea93 100644
--- a/docs/reference/gobject/gobject-sections.txt
+++ b/docs/reference/gobject/gobject-sections.txt
@@ -54,7 +54,6 @@ g_type_class_peek_static
g_type_class_unref
g_type_class_peek_parent
g_type_class_add_private
-g_type_class_get_private
g_type_add_class_private
g_type_interface_peek
g_type_interface_peek_parent
@@ -119,6 +118,7 @@ g_type_check_is_value_type
g_type_check_value
g_type_check_value_holds
g_type_instance_get_private
+g_type_class_get_private
g_type_test_flags
g_type_name_from_instance
g_type_name_from_class
diff --git a/docs/reference/gobject/tmpl/gobject-unused.sgml b/docs/reference/gobject/tmpl/gobject-unused.sgml
index 48f8a2e..a2c641f 100644
--- a/docs/reference/gobject/tmpl/gobject-unused.sgml
+++ b/docs/reference/gobject/tmpl/gobject-unused.sgml
@@ -64,6 +64,15 @@ are set for @type.
@flags: Bitwise combination of #GTypeFlags and #GTypeFundamentalFlags.
@Returns: #TRUE if all @flags are set for @type, #FALSE otherwise.
+<!-- ##### FUNCTION g_type_class_get_private ##### -->
+<para>
+
+</para>
+
+ klass:
+ private_type:
+ Returns:
+
<!-- ##### FUNCTION g_type_instance_is_a ##### -->
<para>
Determines if @instance adheres to the interface exported
diff --git a/gobject/gtype.c b/gobject/gtype.c
index a1e4c85..66ff177 100644
--- a/gobject/gtype.c
+++ b/gobject/gtype.c
@@ -4373,39 +4373,12 @@ g_type_init (void)
* the type and all of its parent types are allocated
* sequentially in the same memory block as the public
* structures. This function should be called in the
- * type's class_init() function. The private structure can
- * be retrieved using the G_TYPE_INSTANCE_GET_PRIVATE() macro.
- * The following example shows attaching a private structure
- * <structname>MyObjectPrivate</structname> to an object
- * <structname>MyObject</structname> defined in the standard GObject
- * fashion.
+ * type's class_init() function.
*
- * |[
- * typedef struct _MyObjectPrivate MyObjectPrivate;
- *
- * struct _MyObjectPrivate {
- * int some_field;
- * };
- *
- * #define MY_OBJECT_GET_PRIVATE(o) \
- * (G_TYPE_INSTANCE_GET_PRIVATE ((o), MY_TYPE_OBJECT, MyObjectPrivate))
- *
- * static void
- * my_object_class_init (MyObjectClass *klass)
- * {
- * g_type_class_add_private (klass, sizeof (MyObjectPrivate));
- * }
- *
- * static int
- * my_object_get_some_field (MyObject *my_object)
- * {
- * MyObjectPrivate *priv = MY_OBJECT_GET_PRIVATE (my_object);
- *
- * return priv->some_field;
- * }
- * ]|
- *
- * Since: 2.4
+ * The private structure can be retrieved using the
+ * G_TYPE_CLASS_GET_PRIVATE() macro.
+
+ * Since: 2.24
*/
void
g_type_class_add_private (gpointer g_class,
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]