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
This commit is contained in:
Sébastien Wilmet 2014-04-21 14:50:53 +02:00
parent 7c205ae90d
commit 430e6fd6ad
6 changed files with 11 additions and 8 deletions

View File

@ -1128,14 +1128,14 @@ GMarkupParser
g_markup_escape_text g_markup_escape_text
g_markup_printf_escaped g_markup_printf_escaped
g_markup_vprintf_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_end_parse
g_markup_parse_context_free g_markup_parse_context_free
g_markup_parse_context_get_position g_markup_parse_context_get_position
g_markup_parse_context_get_element g_markup_parse_context_get_element
g_markup_parse_context_get_element_stack g_markup_parse_context_get_element_stack
g_markup_parse_context_get_user_data 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_push
g_markup_parse_context_pop g_markup_parse_context_pop
g_markup_parse_context_ref g_markup_parse_context_ref

View File

@ -526,7 +526,7 @@ typedef struct _GSubprocess GSubprocess;
* *
* Options for launching a child process. * Options for launching a child process.
* *
* Since: 2.36 * Since: 2.40
*/ */
typedef struct _GSubprocessLauncher GSubprocessLauncher; typedef struct _GSubprocessLauncher GSubprocessLauncher;

View File

@ -39,7 +39,8 @@
/** /**
* SECTION:markup * 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/) * @See_also: [XML Specification](http://www.w3.org/TR/REC-xml/)
* *
* The "GMarkup" parser is intended to parse a simple markup format * The "GMarkup" parser is intended to parse a simple markup format

View File

@ -116,7 +116,8 @@ typedef struct _GMarkupParser GMarkupParser;
/** /**
* GMarkupParser: * GMarkupParser:
* @start_element: Callback to invoke when the opening tag of an element * @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 * @end_element: Callback to invoke when the closing tag of an element
* is seen. Note that this is also called for empty tags like * is seen. Note that this is also called for empty tags like
* `<empty/>`. * `<empty/>`.

View File

@ -132,7 +132,8 @@ g_string_sized_new (gsize dfl_size)
/** /**
* g_string_new: * 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. * Creates a new #GString, initialized with the given string.
* *

View File

@ -1436,7 +1436,7 @@ g_signal_new (const gchar *signal_name,
* *
* See g_signal_new() for information about signal names. * 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. * the marshaller for this signal.
* *
* Returns: the signal id * Returns: the signal id
@ -1564,7 +1564,7 @@ signal_add_class_closure (SignalNode *node,
* *
* See g_signal_new() for details on allowed signal names. * 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. * the marshaller for this signal.
* *
* Returns: the signal id * Returns: the signal id