Docs: Don't use the code tag

This commit is contained in:
Matthias Clasen 2014-01-31 22:05:04 -05:00
parent 17f51583a8
commit a4c33c6f8b
6 changed files with 28 additions and 26 deletions

View File

@ -1452,15 +1452,16 @@ get_session_address_platform_specific (GError **error)
/** /**
* g_dbus_address_get_for_bus_sync: * g_dbus_address_get_for_bus_sync:
* @bus_type: A #GBusType. * @bus_type: a #GBusType
* @cancellable: (allow-none): A #GCancellable or %NULL. * @cancellable: (allow-none): a #GCancellable or %NULL
* @error: Return location for error or %NULL. * @error: return location for error or %NULL
* *
* Synchronously looks up the D-Bus address for the well-known message * Synchronously looks up the D-Bus address for the well-known message
* bus instance specified by @bus_type. This may involve using various * bus instance specified by @bus_type. This may involve using various
* platform specific mechanisms. * platform specific mechanisms.
* *
* Returns: A valid D-Bus address string for @bus_type or %NULL if @error is set. * Returns: a valid D-Bus address string for @bus_type or %NULL if
* @error is set
* *
* Since: 2.26 * Since: 2.26
*/ */
@ -1594,18 +1595,18 @@ g_dbus_address_get_for_bus_sync (GBusType bus_type,
/** /**
* g_dbus_address_escape_value: * g_dbus_address_escape_value:
* @string: an unescaped string to be included in a D-Bus address * @string: an unescaped string to be included in a D-Bus address
* as the value in a key-value pair * as the value in a key-value pair
* *
* Escape @string so it can appear in a D-Bus address as the value * Escape @string so it can appear in a D-Bus address as the value
* part of a key-value pair. * part of a key-value pair.
* *
* For instance, if @string is <code>/run/bus-for-:0</code>, * For instance, if @string is "/run/bus-for-:0",
* this function would return <code>/run/bus-for-%3A0</code>, * this function would return "/run/bus-for-%3A0",
* which could be used in a D-Bus address like * which could be used in a D-Bus address like
* <code>unix:nonce-tcp:host=127.0.0.1,port=42,noncefile=/run/bus-for-%3A0</code>. * "unix:nonce-tcp:host=127.0.0.1,port=42,noncefile=/run/bus-for-%3A0".
* *
* Returns: (transfer full): a copy of @string with all * Returns: (transfer full): a copy of @string with all
* non-optionally-escaped bytes escaped * non-optionally-escaped bytes escaped
* *
* Since: 2.36 * Since: 2.36
*/ */

View File

@ -81,19 +81,19 @@ debug_key_matches (const gchar *key,
* commas, or %NULL. * commas, or %NULL.
* @keys: (array length=nkeys): pointer to an array of #GDebugKey which associate * @keys: (array length=nkeys): pointer to an array of #GDebugKey which associate
* strings with bit flags. * strings with bit flags.
* @nkeys: the number of #GDebugKey<!-- -->s in the array. * @nkeys: the number of #GDebugKeys in the array.
* *
* Parses a string containing debugging options * Parses a string containing debugging options
* into a %guint containing bit flags. This is used * into a %guint containing bit flags. This is used
* within GDK and GTK+ to parse the debug options passed on the * within GDK and GTK+ to parse the debug options passed on the
* command line or through environment variables. * command line or through environment variables.
* *
* If @string is equal to <code>"all"</code>, all flags are set. Any flags * If @string is equal to "all", all flags are set. Any flags
* specified along with <code>"all"</code> in @string are inverted; thus, * specified along with "all" in @string are inverted; thus,
* <code>"all,foo,bar"</code> or <code>"foo,bar,all"</code> sets all flags * "all,foo,bar" or "foo,bar,all" sets all flags except those
* except those corresponding to <code>"foo"</code> and <code>"bar"</code>. * corresponding to "foo" and "bar".
* *
* If @string is equal to <code>"help"</code>, all the available keys in @keys * If @string is equal to "help", all the available keys in @keys
* are printed out to standard error. * are printed out to standard error.
* *
* Returns: the combined set of bit flags. * Returns: the combined set of bit flags.

View File

@ -2486,7 +2486,10 @@ g_variant_new_parsed_va (const gchar *format,
* *
* In the example, the variable argument parameters are collected and * In the example, the variable argument parameters are collected and
* filled in as if they were part of the original string to produce the * filled in as if they were part of the original string to produce the
* result of <code>[('one', 1), ('two', 2), ('three', 3)]</code>. * result of
* |[
* [('one', 1), ('two', 2), ('three', 3)]
* ]|
* *
* This function is intended only to be used with @format as a string * This function is intended only to be used with @format as a string
* literal. Any parse error is fatal to the calling process. If you * literal. Any parse error is fatal to the calling process. If you

View File

@ -1195,11 +1195,11 @@ g_variant_get_fixed_array (GVariant *value,
* @value must be an array with fixed-sized elements. Numeric types are * @value must be an array with fixed-sized elements. Numeric types are
* fixed-size as are tuples containing only other fixed-sized types. * fixed-size as are tuples containing only other fixed-sized types.
* *
* @element_size must be the size of a single element in the array. For * @element_size must be the size of a single element in the array.
* example, if calling this function for an array of 32 bit integers, * For example, if calling this function for an array of 32-bit integers,
* you might say <code>sizeof (gint32)</code>. This value isn't used * you might say sizeof(gint32). This value isn't used except for the purpose
* except for the purpose of a double-check that the form of the * of a double-check that the form of the serialised data matches the caller's
* serialised data matches the caller's expectation. * expectation.
* *
* @n_elements, which must be non-%NULL is set equal to the number of * @n_elements, which must be non-%NULL is set equal to the number of
* items in the array. * items in the array.

View File

@ -1370,9 +1370,8 @@ g_signal_query (guint signal_id,
* be used, but they cannot be mixed. * be used, but they cannot be mixed.
* *
* If 0 is used for @class_offset subclasses cannot override the class handler * If 0 is used for @class_offset subclasses cannot override the class handler
* in their <code>class_init</code> method by doing * in their class_init method by doing super_class->signal_handler = my_signal_handler.
* <code>super_class->signal_handler = my_signal_handler</code>. Instead they * Instead they will have to use g_signal_override_class_handler().
* will have to use g_signal_override_class_handler().
* *
* 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.

View File

@ -295,8 +295,7 @@ g_value_array_insert (GValueArray *value_array,
* g_value_array_remove: * g_value_array_remove:
* @value_array: #GValueArray to remove an element from * @value_array: #GValueArray to remove an element from
* @index_: position of value to remove, which must be less than * @index_: position of value to remove, which must be less than
* <code>value_array-><link * @value_array->n_values
* linkend="GValueArray.n-values">n_values</link></code>
* *
* Remove the value at position @index_ from @value_array. * Remove the value at position @index_ from @value_array.
* *