[glib] Several docs cleanups



commit 083812f8546230deef08a63f2064c293438b3802
Author: Ryan Lortie <desrt desrt ca>
Date:   Thu Oct 6 12:19:58 2011 -0400

    Several docs cleanups

 docs/reference/glib/glib-sections.txt |    8 ++++++++
 glib/deprecated/gthread-deprecated.c  |   11 +++++++++++
 glib/gthread.h                        |    1 +
 glib/gvariant.h                       |    2 +-
 4 files changed, 21 insertions(+), 1 deletions(-)
---
diff --git a/docs/reference/glib/glib-sections.txt b/docs/reference/glib/glib-sections.txt
index 96bc090..6178e67 100644
--- a/docs/reference/glib/glib-sections.txt
+++ b/docs/reference/glib/glib-sections.txt
@@ -902,6 +902,7 @@ g_io_channel_win32_make_pollfd
 g_io_channel_win32_get_fd
 g_io_channel_error_quark
 g_io_watch_funcs
+G_IO_FLAG_IS_WRITEABLE
 </SECTION>
 
 <SECTION>
@@ -1220,6 +1221,7 @@ g_dir_close
 <SUBSECTION>
 GMappedFile
 g_mapped_file_new
+g_mapped_file_new_from_fd
 g_mapped_file_ref
 g_mapped_file_unref
 g_mapped_file_free
@@ -1362,6 +1364,7 @@ g_strsignal
 
 <SUBSECTION Private>
 GAsciiType
+g_ascii_table
 </SECTION>
 
 <SECTION>
@@ -2738,6 +2741,9 @@ g_utf16_to_utf8
 g_ucs4_to_utf16
 g_ucs4_to_utf8
 g_unichar_to_utf8
+
+<SUBSECTION Private>
+g_utf8_skip
 </SECTION>
 
 <SECTION>
@@ -2901,6 +2907,8 @@ g_assertion_message_cmpstr
 g_assertion_message_cmpnum
 g_assertion_message_error
 
+g_test_config_vars
+
 g_test_add_vtable
 GTestConfig
 GTestLogType
diff --git a/glib/deprecated/gthread-deprecated.c b/glib/deprecated/gthread-deprecated.c
index a883434..8e7ee65 100644
--- a/glib/deprecated/gthread-deprecated.c
+++ b/glib/deprecated/gthread-deprecated.c
@@ -35,6 +35,17 @@
 /* {{{1 Documentation */
 
 /**
+ * SECTION:threads-deprecated
+ * @title: Deprecated thread API
+ * @short_description: old thread APIs (for reference only)
+ * @see_also: #GThread
+ *
+ * These APIs are deprecated.  You should not use them in new code.
+ * This section remains only to assist with understanding code that was
+ * written to use these APIs at some point in the past.
+ **/
+
+/**
  * GThreadPriority:
  * @G_THREAD_PRIORITY_LOW: a priority lower than normal
  * @G_THREAD_PRIORITY_NORMAL: the default priority
diff --git a/glib/gthread.h b/glib/gthread.h
index 22fe973..ba7024d 100644
--- a/glib/gthread.h
+++ b/glib/gthread.h
@@ -86,6 +86,7 @@ struct _GRecMutex
 #define G_PRIVATE_INIT(notify) { NULL, (notify), { NULL, NULL } }
 struct _GPrivate
 {
+  /*< private >*/
   gpointer       p;
   GDestroyNotify notify;
   gpointer future[2];
diff --git a/glib/gvariant.h b/glib/gvariant.h
index bd24ef6..84fe95c 100644
--- a/glib/gvariant.h
+++ b/glib/gvariant.h
@@ -93,7 +93,7 @@ GVariant *                      g_variant_new_bytestring_array          (const g
                                                                          gssize                length);
 GVariant *                      g_variant_new_fixed_array               (const GVariantType   *element_type,
                                                                          gconstpointer         elements,
-                                                                         gsize                 num_elements,
+                                                                         gsize                 n_elements,
                                                                          gsize                 element_size);
 gboolean                        g_variant_get_boolean                   (GVariant             *value);
 guchar                          g_variant_get_byte                      (GVariant             *value);



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