doc: various improvements
authorSébastien Wilmet <swilmet@gnome.org>
Mon, 21 Apr 2014 12:50:53 +0000 (14:50 +0200)
committerSébastien Wilmet <swilmet@gnome.org>
Fri, 9 May 2014 16:47:42 +0000 (18:47 +0200)
- 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
gio/giotypes.h
glib/gmarkup.c
glib/gmarkup.h
glib/gstring.c
gobject/gsignal.c

index e8a0fa2afdc15e51b029b9a789563ffa7c373f2c..19eda5c5808dc69c40b184eba4c10c387e7aa44e 100644 (file)
@@ -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
index 0c5df22a4bddae2131cc545719ed0e1882053096..de62cefa2bdc1c71aa7dbd19d5b4cf07c465b1ed 100644 (file)
@@ -526,7 +526,7 @@ typedef struct _GSubprocess                   GSubprocess;
  *
  * Options for launching a child process.
  *
- * Since: 2.36
+ * Since: 2.40
  */
 typedef struct _GSubprocessLauncher           GSubprocessLauncher;
 
index 390a23bfc9154ee65608a4225de92611789d031e..9b60387cdfda04c0a38986ac89ed960599b43489 100644 (file)
@@ -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
index 71ff6aa3023eb62721b464d0d0dc4a1748d3fc66..13b2343a72c4bf8b24bfb985705c04e410c7e1fd 100644 (file)
@@ -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/>`.
index d9a5fdd433fec07e8338b9e5af9d9570667f5c86..f5890bf6424b5d39bf7f2e60277e7ca80beddcd0 100644 (file)
@@ -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.
  *
index e328df87eb55592e53a159b68b6b03c2684be3b2..c81a041ca169f2163dae4fee3c8f135a51adef47 100644 (file)
@@ -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