mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2025-02-19 08:42:09 +01:00
docs: Make docs more markdown-ish
Fixed some issues that came to light while compiling documentation for the python bindings.
This commit is contained in:
parent
0234f8e1b1
commit
04acc1741b
@ -40,6 +40,7 @@
|
||||
* “Low Power” mode on some systems).
|
||||
*
|
||||
* When in “Low Power” mode, it is recommended that applications:
|
||||
*
|
||||
* - disable automatic downloads;
|
||||
* - reduce the rate of refresh from online sources such as calendar or
|
||||
* email synchronisation;
|
||||
|
@ -2627,14 +2627,14 @@ g_markup_parse_boolean (const char *string,
|
||||
* @G_MARKUP_COLLECT_STRDUP: as with %G_MARKUP_COLLECT_STRING, but
|
||||
* expects a parameter of type (char **) and g_strdup()s the
|
||||
* returned pointer. The pointer must be freed with g_free()
|
||||
* @G_MARKUP_COLLECT_BOOLEAN: expects a parameter of type (gboolean *)
|
||||
* @G_MARKUP_COLLECT_BOOLEAN: expects a parameter of type (`gboolean *`)
|
||||
* and parses the attribute value as a boolean. Sets %FALSE if the
|
||||
* attribute isn't present. Valid boolean values consist of
|
||||
* (case-insensitive) "false", "f", "no", "n", "0" and "true", "t",
|
||||
* "yes", "y", "1"
|
||||
* @G_MARKUP_COLLECT_TRISTATE: as with %G_MARKUP_COLLECT_BOOLEAN, but
|
||||
* in the case of a missing attribute a value is set that compares
|
||||
* equal to neither %FALSE nor %TRUE G_MARKUP_COLLECT_OPTIONAL is
|
||||
* equal to neither %FALSE nor %TRUE %G_MARKUP_COLLECT_OPTIONAL is
|
||||
* implied
|
||||
* @G_MARKUP_COLLECT_OPTIONAL: can be bitwise ORed with the other fields.
|
||||
* If present, allows the attribute not to appear. A default value
|
||||
|
@ -241,7 +241,7 @@ GQuark g_option_error_quark (void);
|
||||
* @long_name: The long name of an option can be used to specify it
|
||||
* in a commandline as `--long_name`. Every option must have a
|
||||
* long name. To resolve conflicts if multiple option groups contain
|
||||
* the same long name, it is also possible to specify the option as
|
||||
* the same long name, it is also possible to specify the option as
|
||||
* `--groupname-long_name`.
|
||||
* @short_name: If an option has a short name, it can be specified
|
||||
* `-short_name` in a commandline. @short_name must be a printable
|
||||
@ -254,13 +254,15 @@ GQuark g_option_error_quark (void);
|
||||
* called to handle the extra argument. Otherwise, @arg_data is a
|
||||
* pointer to a location to store the value, the required type of
|
||||
* the location depends on the @arg type:
|
||||
* - %G_OPTION_ARG_NONE: %gboolean
|
||||
* - %G_OPTION_ARG_STRING: %gchar*
|
||||
* - %G_OPTION_ARG_INT: %gint
|
||||
* - %G_OPTION_ARG_FILENAME: %gchar*
|
||||
* - %G_OPTION_ARG_STRING_ARRAY: %gchar**
|
||||
* - %G_OPTION_ARG_FILENAME_ARRAY: %gchar**
|
||||
* - %G_OPTION_ARG_DOUBLE: %gdouble
|
||||
*
|
||||
* - %G_OPTION_ARG_NONE: %gboolean
|
||||
* - %G_OPTION_ARG_STRING: %gchar*
|
||||
* - %G_OPTION_ARG_INT: %gint
|
||||
* - %G_OPTION_ARG_FILENAME: %gchar*
|
||||
* - %G_OPTION_ARG_STRING_ARRAY: %gchar**
|
||||
* - %G_OPTION_ARG_FILENAME_ARRAY: %gchar**
|
||||
* - %G_OPTION_ARG_DOUBLE: %gdouble
|
||||
*
|
||||
* If @arg type is %G_OPTION_ARG_STRING or %G_OPTION_ARG_FILENAME,
|
||||
* the location will contain a newly allocated string if the option
|
||||
* was given. That string needs to be freed by the callee using g_free().
|
||||
@ -273,7 +275,7 @@ GQuark g_option_error_quark (void);
|
||||
* by the option in `--help` output. The @arg_description is translated
|
||||
* using the @translate_func of the group, see
|
||||
* g_option_group_set_translation_domain().
|
||||
*
|
||||
*
|
||||
* A GOptionEntry struct defines a single option. To have an effect, they
|
||||
* must be added to a #GOptionGroup with g_option_context_add_main_entries()
|
||||
* or g_option_group_add_entries().
|
||||
|
@ -2187,14 +2187,14 @@ out:
|
||||
* It replaces the following special characters in the string @source
|
||||
* with their corresponding C escape sequence:
|
||||
*
|
||||
* Symbol | Escape
|
||||
* ---|---
|
||||
* [U+0008 Backspace](https://en.wikipedia.org/wiki/Backspace) | `\b`
|
||||
* [U+000C Form Feed](https://en.wikipedia.org/wiki/Form_feed) | `\f`
|
||||
* [U+000A Line Feed](https://en.wikipedia.org/wiki/Newline) | `\n`
|
||||
* [U+000D Carriage Return](https://en.wikipedia.org/wiki/Carriage_return) | `\r`
|
||||
* [U+0009 Horizontal Tabulation](https://en.wikipedia.org/wiki/Tab_character) | `\t`
|
||||
* [U+000B Vertical Tabulation](https://en.wikipedia.org/wiki/Vertical_Tab) | `\v`
|
||||
* | Symbol | Escape |
|
||||
* |-----------------------------------------------------------------------------|--------|
|
||||
* | [U+0008 Backspace](https://en.wikipedia.org/wiki/Backspace) | `\b` |
|
||||
* | [U+000C Form Feed](https://en.wikipedia.org/wiki/Form_feed) | `\f` |
|
||||
* | [U+000A Line Feed](https://en.wikipedia.org/wiki/Newline) | `\n` |
|
||||
* | [U+000D Carriage Return](https://en.wikipedia.org/wiki/Carriage_return) | `\r` |
|
||||
* | [U+0009 Horizontal Tabulation](https://en.wikipedia.org/wiki/Tab_character) | `\t` |
|
||||
* | [U+000B Vertical Tabulation](https://en.wikipedia.org/wiki/Vertical_Tab) | `\v` |
|
||||
*
|
||||
* It also inserts a backslash (`\`) before any backslash or a double quote (`"`).
|
||||
* Additionally all characters in the range 0x01-0x1F (everything
|
||||
|
@ -1420,10 +1420,12 @@ typedef gchar * (* GTypeValueLCopyFunc) (const GValue *value,
|
||||
* this value bit-by-bit. Each character in the format represents
|
||||
* an argument to be collected, and the characters themselves indicate
|
||||
* the type of the argument. Currently supported arguments are:
|
||||
* - `'i'`: Integers, passed as `collect_values[].v_int`
|
||||
* - `'l'`: Longs, passed as `collect_values[].v_long`
|
||||
* - `'d'`: Doubles, passed as `collect_values[].v_double`
|
||||
* - `'p'`: Pointers, passed as `collect_values[].v_pointer`
|
||||
*
|
||||
* - `'i'`: Integers, passed as `collect_values[].v_int`
|
||||
* - `'l'`: Longs, passed as `collect_values[].v_long`
|
||||
* - `'d'`: Doubles, passed as `collect_values[].v_double`
|
||||
* - `'p'`: Pointers, passed as `collect_values[].v_pointer`
|
||||
*
|
||||
* It should be noted that for variable argument list construction,
|
||||
* ANSI C promotes every type smaller than an integer to an int, and
|
||||
* floats to doubles. So for collection of short int or char, `'i'`
|
||||
|
Loading…
x
Reference in New Issue
Block a user