[glib] doc: various improvements



commit 430e6fd6ad4ecf68ca110e90a626a60fd5d4eca8
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Mon Apr 21 14:50:53 2014 +0200

    doc: various improvements
    
    - GSubprocessLauncher exists since 2.40, not 2.36
    - more logical order for g_markup functions
    - fix short description of GMarkup
    - GMarkupParser: specify that some parameters are NULL-terminated.
    - g_string_new (NULL); is possible.
    - other trivial fixes.
    
    https://bugzilla.gnome.org/show_bug.cgi?id=728983

 docs/reference/glib/glib-sections.txt |    4 ++--
 gio/giotypes.h                        |    2 +-
 glib/gmarkup.c                        |    3 ++-
 glib/gmarkup.h                        |    3 ++-
 glib/gstring.c                        |    3 ++-
 gobject/gsignal.c                     |    4 ++--
 6 files changed, 11 insertions(+), 8 deletions(-)
---
diff --git a/docs/reference/glib/glib-sections.txt b/docs/reference/glib/glib-sections.txt
index e8a0fa2..19eda5c 100644
--- a/docs/reference/glib/glib-sections.txt
+++ b/docs/reference/glib/glib-sections.txt
@@ -1128,14 +1128,14 @@ GMarkupParser
 g_markup_escape_text
 g_markup_printf_escaped
 g_markup_vprintf_escaped
+g_markup_parse_context_new
+g_markup_parse_context_parse
 g_markup_parse_context_end_parse
 g_markup_parse_context_free
 g_markup_parse_context_get_position
 g_markup_parse_context_get_element
 g_markup_parse_context_get_element_stack
 g_markup_parse_context_get_user_data
-g_markup_parse_context_new
-g_markup_parse_context_parse
 g_markup_parse_context_push
 g_markup_parse_context_pop
 g_markup_parse_context_ref
diff --git a/gio/giotypes.h b/gio/giotypes.h
index 0c5df22..de62cef 100644
--- a/gio/giotypes.h
+++ b/gio/giotypes.h
@@ -526,7 +526,7 @@ typedef struct _GSubprocess                   GSubprocess;
  *
  * Options for launching a child process.
  *
- * Since: 2.36
+ * Since: 2.40
  */
 typedef struct _GSubprocessLauncher           GSubprocessLauncher;
 
diff --git a/glib/gmarkup.c b/glib/gmarkup.c
index 390a23b..9b60387 100644
--- a/glib/gmarkup.c
+++ b/glib/gmarkup.c
@@ -39,7 +39,8 @@
 
 /**
  * SECTION:markup
- * @Title: Simple XML Subset Parser * @Short_description: parses a subset of XML
+ * @Title: Simple XML Subset Parser
+ * @Short_description: parses a subset of XML
  * @See_also: [XML Specification](http://www.w3.org/TR/REC-xml/)
  *
  * The "GMarkup" parser is intended to parse a simple markup format
diff --git a/glib/gmarkup.h b/glib/gmarkup.h
index 71ff6aa..13b2343 100644
--- a/glib/gmarkup.h
+++ b/glib/gmarkup.h
@@ -116,7 +116,8 @@ typedef struct _GMarkupParser GMarkupParser;
 /**
  * GMarkupParser:
  * @start_element: Callback to invoke when the opening tag of an element
- *     is seen.
+ *     is seen. The callback's @attribute_names and @attribute_values parameters
+ *     are %NULL-terminated.
  * @end_element: Callback to invoke when the closing tag of an element
  *     is seen. Note that this is also called for empty tags like
  *     `<empty/>`.
diff --git a/glib/gstring.c b/glib/gstring.c
index d9a5fdd..f5890bf 100644
--- a/glib/gstring.c
+++ b/glib/gstring.c
@@ -132,7 +132,8 @@ g_string_sized_new (gsize dfl_size)
 
 /**
  * g_string_new:
- * @init: the initial text to copy into the string
+ * @init: (allow-none): the initial text to copy into the string, or %NULL to
+ * start with an empty string.
  *
  * Creates a new #GString, initialized with the given string.
  *
diff --git a/gobject/gsignal.c b/gobject/gsignal.c
index e328df8..c81a041 100644
--- a/gobject/gsignal.c
+++ b/gobject/gsignal.c
@@ -1436,7 +1436,7 @@ g_signal_new (const gchar  *signal_name,
  *
  * See g_signal_new() for information about signal names.
  *
- * If c_marshaller is %NULL @g_cclosure_marshal_generic will be used as
+ * If c_marshaller is %NULL, g_cclosure_marshal_generic() will be used as
  * the marshaller for this signal.
  *
  * Returns: the signal id
@@ -1564,7 +1564,7 @@ signal_add_class_closure (SignalNode *node,
  *
  * See g_signal_new() for details on allowed signal names.
  *
- * If c_marshaller is %NULL @g_cclosure_marshal_generic will be used as
+ * If c_marshaller is %NULL, g_cclosure_marshal_generic() will be used as
  * the marshaller for this signal.
  *
  * Returns: the signal id


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