luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-08-01 15:03:39 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: Ditch more markup

Browse Source 
Some markup was hiding in docs in headers. Drop it there, too.
This commit is contained in:
Matthias Clasen
2014-03-02 18:20:37 -05:00
parent ad4d81418e
commit 49cc207e35
12 changed files with 160 additions and 198 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
gio/gdbusconnection.h
View File

@@ -340,36 +340,32 @@ typedef gboolean (*GDBusInterfaceSetPropertyFunc) (GDBusConnection *conne
* *
* Since 2.38, if you want to handle getting/setting D-Bus properties * Since 2.38, if you want to handle getting/setting D-Bus properties
* asynchronously, give %NULL as your get_property() or set_property() * asynchronously, give %NULL as your get_property() or set_property()
* function. The D-Bus call will be directed to your @method_call * function. The D-Bus call will be directed to your @method_call function,
* function, with the provided @interface_name set to * with the provided @interface_name set to "org.freedesktop.DBus.Properties".
* <literal>"org.freedesktop.DBus.Properties"</literal>.
* *
* The usual checks on the validity of the calls is performed. For * The usual checks on the validity of the calls is performed. For
* <literal>'Get'</literal> calls, an error is automatically returned if * `Get` calls, an error is automatically returned if the property does
* the property does not exist or the permissions do not allow access. * not exist or the permissions do not allow access. The same checks are
* The same checks are performed for <literal>'Set'</literal> calls, and * performed for `Set` calls, and the provided value is also checked for
* the provided value is also checked for being the correct type. * being the correct type.
* *
* For both <literal>'Get'</literal> and <literal>'Set'</literal> calls, * For both `Get` and `Set` calls, the #GDBusMethodInvocation
* the #GDBusMethodInvocation passed to the method_call handler can be * passed to the @method_call handler can be queried with
* queried with g_dbus_method_invocation_get_property_info() to get a * g_dbus_method_invocation_get_property_info() to get a pointer
* pointer to the #GDBusPropertyInfo of the property. * to the #GDBusPropertyInfo of the property.
* *
* If you have readable properties specified in your interface info, you * If you have readable properties specified in your interface info,
* must ensure that you either provide a non-%NULL @get_property() * you must ensure that you either provide a non-%NULL @get_property()
* function or provide implementations of both the * function or provide implementations of both the `Get` and `GetAll`
* <literal>'Get'</literal> and <literal>'GetAll'</literal> methods on * methods on org.freedesktop.DBus.Properties interface in your @method_call
* the <literal>'org.freedesktop.DBus.Properties'</literal> interface in * function. Note that the required return type of the `Get` call is
* your @method_call function. Note that the required return type of * `(v)`, not the type of the property. `GetAll` expects a return value
* the <literal>'Get'</literal> call is <literal>(v)</literal>, not the * of type `a{sv}`.
* type of the property. <literal>'GetAll'</literal> expects a return
* value of type <literal>a{sv}</literal>.
* *
* If you have writable properties specified in your interface info, you * If you have writable properties specified in your interface info,
* must ensure that you either provide a non-%NULL @set_property() * you must ensure that you either provide a non-%NULL @set_property()
* function or provide an implementation of the <literal>'Set'</literal> * function or provide an implementation of the `Set` call. If implementing
* call. If implementing the call, you must return the value of type * the call, you must return the value of type %G_VARIANT_TYPE_UNIT.
* %G_VARIANT_TYPE_UNIT.
* *
* Since: 2.26 * Since: 2.26
*/ */

15
gio/gioenums.h
View File

@@ -218,9 +218,9 @@ typedef enum {
* @G_FILE_MEASURE_APPARENT_SIZE: Tally usage based on apparent file * @G_FILE_MEASURE_APPARENT_SIZE: Tally usage based on apparent file
* sizes. Normally, the block-size is used, if available, as this is a * sizes. Normally, the block-size is used, if available, as this is a
* more accurate representation of disk space used. * more accurate representation of disk space used.
* Compare with '<literal>du --apparent-size</literal>'. * Compare with `du --apparent-size`.
* @G_FILE_MEASURE_NO_XDEV: Do not cross mount point boundaries. * @G_FILE_MEASURE_NO_XDEV: Do not cross mount point boundaries.
* Compare with '<literal>du -x</literal>'. * Compare with `du -x`.
* *
* Flags that can be used with g_file_measure_disk_usage(). * Flags that can be used with g_file_measure_disk_usage().
* *
@@ -867,12 +867,11 @@ typedef enum {
* or a socket created with socketpair()). * or a socket created with socketpair()).
* *
* For abstract sockets, there are two incompatible ways of naming * For abstract sockets, there are two incompatible ways of naming
* them; the man pages suggest using the entire <literal>struct * them; the man pages suggest using the entire `struct sockaddr_un`
* sockaddr_un</literal> as the name, padding the unused parts of the * as the name, padding the unused parts of the %sun_path field with
* %sun_path field with zeroes; this corresponds to * zeroes; this corresponds to %G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED.
* %G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED. However, many programs * However, many programs instead just use a portion of %sun_path, and
* instead just use a portion of %sun_path, and pass an appropriate * pass an appropriate smaller length to bind() or connect(). This is
* smaller length to bind() or connect(). This is
* %G_UNIX_SOCKET_ADDRESS_ABSTRACT. * %G_UNIX_SOCKET_ADDRESS_ABSTRACT.
* *
* Since: 2.26 * Since: 2.26

2
gio/gsettings.h
View File

@@ -264,7 +264,7 @@ typedef gboolean (*GSettingsGetMapping) (GVarian
/** /**
* GSettingsBindFlags: * GSettingsBindFlags:
* @G_SETTINGS_BIND_DEFAULT: Equivalent to <literal>G_SETTINGS_BIND_GET|G_SETTINGS_BIND_SET</literal> * @G_SETTINGS_BIND_DEFAULT: Equivalent to `G_SETTINGS_BIND_GET|G_SETTINGS_BIND_SET`
* @G_SETTINGS_BIND_GET: Update the #GObject property when the setting changes. * @G_SETTINGS_BIND_GET: Update the #GObject property when the setting changes.
* It is an error to use this flag if the property is not writable. * It is an error to use this flag if the property is not writable.
* @G_SETTINGS_BIND_SET: Update the setting when the #GObject property changes. * @G_SETTINGS_BIND_SET: Update the setting when the #GObject property changes.

13
gio/gvolume.h
View File

@@ -68,18 +68,15 @@ G_BEGIN_DECLS
/** /**
* G_VOLUME_IDENTIFIER_KIND_CLASS: * G_VOLUME_IDENTIFIER_KIND_CLASS:
* *
* The string used to obtain the volume <emphasis>class</emphasis> * The string used to obtain the volume class with g_volume_get_identifier().
* with g_volume_get_identifier().
* *
* Known volume classes include <literal>device</literal> and * Known volume classes include `device` and `network`. Other classes may
* <literal>network</literal>. Other classes may be added in the * be added in the future.
* future.
* *
* This is intended to be used by applications to classify #GVolume * This is intended to be used by applications to classify #GVolume
* instances into different sections - for example a file manager or * instances into different sections - for example a file manager or
* file chooser can use this information to show * file chooser can use this information to show `network` volumes under
* <literal>network</literal> volumes under a "Network" heading and * a "Network" heading and `device` volumes under a "Devices" heading.
* <literal>device</literal> volumes under a "Devices" heading.
*/ */
#define G_VOLUME_IDENTIFIER_KIND_CLASS "class" #define G_VOLUME_IDENTIFIER_KIND_CLASS "class"

2
glib/gbacktrace.h
View File

@@ -45,7 +45,7 @@ void g_on_error_stack_trace (const gchar *prg_name);
* Inserts a breakpoint instruction into the code. * Inserts a breakpoint instruction into the code.
* *
* On x86 and alpha systems this is implemented as a soft interrupt * On x86 and alpha systems this is implemented as a soft interrupt
* and on other architectures it raises a <literal>SIGTRAP</literal> signal. * and on other architectures it raises a `SIGTRAP` signal.
*/ */
#if (defined (__i386__) || defined (__x86_64__)) && defined (__GNUC__) && __GNUC__ >= 2 #if (defined (__i386__) || defined (__x86_64__)) && defined (__GNUC__) && __GNUC__ >= 2
# define G_BREAKPOINT() G_STMT_START{ __asm__ __volatile__ ("int $03"); }G_STMT_END # define G_BREAKPOINT() G_STMT_START{ __asm__ __volatile__ ("int $03"); }G_STMT_END

4
glib/gmarkup.h
View File

@@ -79,7 +79,7 @@ GQuark g_markup_error_quark (void);
* @G_MARKUP_TREAT_CDATA_AS_TEXT: When this flag is set, CDATA marked * @G_MARKUP_TREAT_CDATA_AS_TEXT: When this flag is set, CDATA marked
* sections are not passed literally to the @passthrough function of * sections are not passed literally to the @passthrough function of
* the parser. Instead, the content of the section (without the * the parser. Instead, the content of the section (without the
* <literal>&lt;![CDATA[</literal> and <literal>]]&gt;</literal>) is * `<![CDATA[` and `]]>`) is
* passed to the @text function. This flag was added in GLib 2.12 * passed to the @text function. This flag was added in GLib 2.12
* @G_MARKUP_PREFIX_ERROR_POSITION: Normally errors caught by GMarkup * @G_MARKUP_PREFIX_ERROR_POSITION: Normally errors caught by GMarkup
* itself have line/column information prefixed to them to let the * itself have line/column information prefixed to them to let the
@@ -119,7 +119,7 @@ typedef struct _GMarkupParser GMarkupParser;
* is seen. * is seen.
* @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
* <literal>&lt;empty/&gt;</literal>. * `<empty/>`.
* @text: Callback to invoke when some text is seen (text is always * @text: Callback to invoke when some text is seen (text is always
* inside an element). Note that the text of an element may be spread * inside an element). Note that the text of an element may be spread
* over multiple calls of this function. If the * over multiple calls of this function. If the

137
glib/goption.h
View File

@@ -53,12 +53,11 @@ typedef struct _GOptionEntry GOptionEntry;
/** /**
* GOptionFlags: * GOptionFlags:
* @G_OPTION_FLAG_HIDDEN: The option doesn't appear in <option>--help</option> * @G_OPTION_FLAG_HIDDEN: The option doesn't appear in `--help` output.
* output.
* @G_OPTION_FLAG_IN_MAIN: The option appears in the main section of the * @G_OPTION_FLAG_IN_MAIN: The option appears in the main section of the
* <option>--help</option> output, even if it is defined in a group. * `--help` output, even if it is defined in a group.
* @G_OPTION_FLAG_REVERSE: For options of the %G_OPTION_ARG_NONE kind, this flag * @G_OPTION_FLAG_REVERSE: For options of the %G_OPTION_ARG_NONE kind, this
* indicates that the sense of the option is reversed. * flag indicates that the sense of the option is reversed.
* @G_OPTION_FLAG_NO_ARG: For options of the %G_OPTION_ARG_CALLBACK kind, * @G_OPTION_FLAG_NO_ARG: For options of the %G_OPTION_ARG_CALLBACK kind,
* this flag indicates that the callback does not take any argument * this flag indicates that the callback does not take any argument
* (like a %G_OPTION_ARG_NONE option). Since 2.8 * (like a %G_OPTION_ARG_NONE option). Since 2.8
@@ -66,14 +65,15 @@ typedef struct _GOptionEntry GOptionEntry;
* kind, this flag indicates that the argument should be passed to the * kind, this flag indicates that the argument should be passed to the
* callback in the GLib filename encoding rather than UTF-8. Since 2.8 * callback in the GLib filename encoding rather than UTF-8. Since 2.8
* @G_OPTION_FLAG_OPTIONAL_ARG: For options of the %G_OPTION_ARG_CALLBACK * @G_OPTION_FLAG_OPTIONAL_ARG: For options of the %G_OPTION_ARG_CALLBACK
* kind, this flag indicates that the argument supply is optional. If no argument * kind, this flag indicates that the argument supply is optional.
* is given then data of %GOptionParseFunc will be set to NULL. Since 2.8 * If no argument is given then data of %GOptionParseFunc will be
* @G_OPTION_FLAG_NOALIAS: This flag turns off the automatic conflict resolution * set to NULL. Since 2.8
* which prefixes long option names with <literal>groupname-</literal> if * @G_OPTION_FLAG_NOALIAS: This flag turns off the automatic conflict
* there is a conflict. This option should only be used in situations where * resolution which prefixes long option names with `groupname-` if
* aliasing is necessary to model some legacy commandline interface. It is * there is a conflict. This option should only be used in situations
* not safe to use this option, unless all option groups are under your * where aliasing is necessary to model some legacy commandline interface.
* direct control. Since 2.8. * It is not safe to use this option, unless all option groups are under
* your direct control. Since 2.8.
* *
* Flags which modify individual options. * Flags which modify individual options.
*/ */
@@ -101,17 +101,17 @@ typedef enum
* @G_OPTION_ARG_FILENAME_ARRAY: The option takes a filename as argument, * @G_OPTION_ARG_FILENAME_ARRAY: The option takes a filename as argument,
* multiple uses of the option are collected into an array of strings. * multiple uses of the option are collected into an array of strings.
* @G_OPTION_ARG_DOUBLE: The option takes a double argument. The argument * @G_OPTION_ARG_DOUBLE: The option takes a double argument. The argument
* can be formatted either for the user's locale or for the "C" locale. Since 2.12 * can be formatted either for the user's locale or for the "C" locale.
* @G_OPTION_ARG_INT64: The option takes a 64-bit integer. Like %G_OPTION_ARG_INT
* but for larger numbers. The number can be in decimal base, or in hexadecimal
* (when prefixed with <literal>0x</literal>, for example, <literal>0xffffffff</literal>).
* Since 2.12 * Since 2.12
* @G_OPTION_ARG_INT64: The option takes a 64-bit integer. Like
* %G_OPTION_ARG_INT but for larger numbers. The number can be in
* decimal base, or in hexadecimal (when prefixed with `0x`, for
* example, `0xffffffff`). Since 2.12
* *
* The #GOptionArg enum values determine which type of extra argument the * The #GOptionArg enum values determine which type of extra argument the
* options expect to find. If an option expects an extra argument, it * options expect to find. If an option expects an extra argument, it can
* can be specified in several ways; with a short option: * be specified in several ways; with a short option: `-x arg`, with a long
* <option>-x arg</option>, with a long option: <option>--name arg</option> * option: `--name arg` or combined in a single argument: `--name=arg`.
* or combined in a single argument: <option>--name=arg</option>.
*/ */
typedef enum typedef enum
{ {
@@ -213,67 +213,44 @@ GQuark g_option_error_quark (void);
/** /**
* GOptionEntry: * GOptionEntry:
* @long_name: The long name of an option can be used to specify it * @long_name: The long name of an option can be used to specify it
* in a commandline as --<replaceable>long_name</replaceable>. Every * in a commandline as `--long_name`. Every option must have a
* option must have a long name. To resolve conflicts if multiple * long name. To resolve conflicts if multiple option groups contain
* option groups contain the same long name, it is also possible to * the same long name, it is also possible to specify the option as
* specify the option as * `--groupname-long_name`.
* --<replaceable>groupname</replaceable>-<replaceable>long_name</replaceable>.
* @short_name: If an option has a short name, it can be specified * @short_name: If an option has a short name, it can be specified
* -<replaceable>short_name</replaceable> in a commandline. @short_name must be * `-short_name` in a commandline. @short_name must be a printable
* a printable ASCII character different from '-', or zero if the option has no * ASCII character different from '-', or zero if the option has no
* short name. * short name.
* @flags: Flags from #GOptionFlags. * @flags: Flags from #GOptionFlags
* @arg: The type of the option, as a #GOptionArg. * @arg: The type of the option, as a #GOptionArg
* @arg_data: If the @arg type is %G_OPTION_ARG_CALLBACK, then @arg_data must * @arg_data: If the @arg type is %G_OPTION_ARG_CALLBACK, then @arg_data
* point to a #GOptionArgFunc callback function, which will be called to handle * must point to a #GOptionArgFunc callback function, which will be
* the extra argument. Otherwise, @arg_data is a pointer to a location to store * called to handle the extra argument. Otherwise, @arg_data is a
* the value, the required type of the location depends on the @arg type: * pointer to a location to store the value, the required type of
* <variablelist> * the location depends on the @arg type:
* <varlistentry> * - %G_OPTION_ARG_NONE: %gboolean
* <term>%G_OPTION_ARG_NONE</term> * - %G_OPTION_ARG_STRING: %gchar*
* <listitem><para>%gboolean</para></listitem> * - %G_OPTION_ARG_INT: %gint
* </varlistentry> * - %G_OPTION_ARG_FILENAME: %gchar*
* <varlistentry> * - %G_OPTION_ARG_STRING_ARRAY: %gchar**
* <term>%G_OPTION_ARG_STRING</term> * - %G_OPTION_ARG_FILENAME_ARRAY: %gchar**
* <listitem><para>%gchar*</para></listitem> * - %G_OPTION_ARG_DOUBLE: %gdouble
* </varlistentry> * If @arg type is %G_OPTION_ARG_STRING or %G_OPTION_ARG_FILENAME,
* <varlistentry> * the location will contain a newly allocated string if the option
* <term>%G_OPTION_ARG_INT</term> * was given. That string needs to be freed by the callee using g_free().
* <listitem><para>%gint</para></listitem> * Likewise if @arg type is %G_OPTION_ARG_STRING_ARRAY or
* </varlistentry> * %G_OPTION_ARG_FILENAME_ARRAY, the data should be freed using g_strfreev().
* <varlistentry> * @description: the description for the option in `--help`
* <term>%G_OPTION_ARG_FILENAME</term> * output. The @description is translated using the @translate_func
* <listitem><para>%gchar*</para></listitem> * of the group, see g_option_group_set_translation_domain().
* </varlistentry>
* <varlistentry>
* <term>%G_OPTION_ARG_STRING_ARRAY</term>
* <listitem><para>%gchar**</para></listitem>
* </varlistentry>
* <varlistentry>
* <term>%G_OPTION_ARG_FILENAME_ARRAY</term>
* <listitem><para>%gchar**</para></listitem>
* </varlistentry>
* <varlistentry>
* <term>%G_OPTION_ARG_DOUBLE</term>
* <listitem><para>%gdouble</para></listitem>
* </varlistentry>
* </variablelist>
* 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(). Likewise if @arg type is
* %G_OPTION_ARG_STRING_ARRAY or %G_OPTION_ARG_FILENAME_ARRAY, the data should
* be freed using g_strfreev().
* @description: the description for the option in <option>--help</option>
* output. The @description is translated using the @translate_func of the
* group, see g_option_group_set_translation_domain().
* @arg_description: The placeholder to use for the extra argument parsed * @arg_description: The placeholder to use for the extra argument parsed
* by the option in <option>--help</option> * by the option in `--help` output. The @arg_description is translated
* output. The @arg_description is translated using the @translate_func of the * using the @translate_func of the group, see
* group, see g_option_group_set_translation_domain(). * g_option_group_set_translation_domain().
* *
* A <structname>GOptionEntry</structname> defines a single option. * A GOptionEntry struct defines a single option. To have an effect, they
* To have an effect, they must be added to a #GOptionGroup with * must be added to a #GOptionGroup with g_option_context_add_main_entries()
* g_option_context_add_main_entries() or g_option_group_add_entries(). * or g_option_group_add_entries().
*/ */
struct _GOptionEntry struct _GOptionEntry
{ {
@@ -293,12 +270,12 @@ struct _GOptionEntry
* *
* If a long option in the main group has this name, it is not treated as a * If a long option in the main group has this name, it is not treated as a
* regular option. Instead it collects all non-option arguments which would * regular option. Instead it collects all non-option arguments which would
* otherwise be left in <literal>argv</literal>. The option must be of type * otherwise be left in `argv`. The option must be of type
* %G_OPTION_ARG_CALLBACK, %G_OPTION_ARG_STRING_ARRAY * %G_OPTION_ARG_CALLBACK, %G_OPTION_ARG_STRING_ARRAY
* or %G_OPTION_ARG_FILENAME_ARRAY. * or %G_OPTION_ARG_FILENAME_ARRAY.
* *
* *
* Using #G_OPTION_REMAINING instead of simply scanning <literal>argv</literal> * Using #G_OPTION_REMAINING instead of simply scanning `argv`
* for leftover arguments has the advantage that GOption takes care of * for leftover arguments has the advantage that GOption takes care of
* necessary encoding conversions for strings or filenames. * necessary encoding conversions for strings or filenames.
* *

89
glib/gspawn.h
View File

@@ -45,25 +45,25 @@ G_BEGIN_DECLS
* @G_SPAWN_ERROR_FORK: Fork failed due to lack of memory. * @G_SPAWN_ERROR_FORK: Fork failed due to lack of memory.
* @G_SPAWN_ERROR_READ: Read or select on pipes failed. * @G_SPAWN_ERROR_READ: Read or select on pipes failed.
* @G_SPAWN_ERROR_CHDIR: Changing to working directory failed. * @G_SPAWN_ERROR_CHDIR: Changing to working directory failed.
* @G_SPAWN_ERROR_ACCES: execv() returned <literal>EACCES</literal> * @G_SPAWN_ERROR_ACCES: execv() returned `EACCES`
* @G_SPAWN_ERROR_PERM: execv() returned <literal>EPERM</literal> * @G_SPAWN_ERROR_PERM: execv() returned `EPERM`
* @G_SPAWN_ERROR_TOO_BIG: execv() returned <literal>E2BIG</literal> * @G_SPAWN_ERROR_TOO_BIG: execv() returned `E2BIG`
* @G_SPAWN_ERROR_2BIG: deprecated alias for %G_SPAWN_ERROR_TOO_BIG * @G_SPAWN_ERROR_2BIG: deprecated alias for %G_SPAWN_ERROR_TOO_BIG
* @G_SPAWN_ERROR_NOEXEC: execv() returned <literal>ENOEXEC</literal> * @G_SPAWN_ERROR_NOEXEC: execv() returned `ENOEXEC`
* @G_SPAWN_ERROR_NAMETOOLONG: execv() returned <literal>ENAMETOOLONG</literal> * @G_SPAWN_ERROR_NAMETOOLONG: execv() returned `ENAMETOOLONG`
* @G_SPAWN_ERROR_NOENT: execv() returned <literal>ENOENT</literal> * @G_SPAWN_ERROR_NOENT: execv() returned `ENOENT`
* @G_SPAWN_ERROR_NOMEM: execv() returned <literal>ENOMEM</literal> * @G_SPAWN_ERROR_NOMEM: execv() returned `ENOMEM`
* @G_SPAWN_ERROR_NOTDIR: execv() returned <literal>ENOTDIR</literal> * @G_SPAWN_ERROR_NOTDIR: execv() returned `ENOTDIR`
* @G_SPAWN_ERROR_LOOP: execv() returned <literal>ELOOP</literal> * @G_SPAWN_ERROR_LOOP: execv() returned `ELOOP`
* @G_SPAWN_ERROR_TXTBUSY: execv() returned <literal>ETXTBUSY</literal> * @G_SPAWN_ERROR_TXTBUSY: execv() returned `ETXTBUSY`
* @G_SPAWN_ERROR_IO: execv() returned <literal>EIO</literal> * @G_SPAWN_ERROR_IO: execv() returned `EIO`
* @G_SPAWN_ERROR_NFILE: execv() returned <literal>ENFILE</literal> * @G_SPAWN_ERROR_NFILE: execv() returned `ENFILE`
* @G_SPAWN_ERROR_MFILE: execv() returned <literal>EMFILE</literal> * @G_SPAWN_ERROR_MFILE: execv() returned `EMFILE`
* @G_SPAWN_ERROR_INVAL: execv() returned <literal>EINVAL</literal> * @G_SPAWN_ERROR_INVAL: execv() returned `EINVAL`
* @G_SPAWN_ERROR_ISDIR: execv() returned <literal>EISDIR</literal> * @G_SPAWN_ERROR_ISDIR: execv() returned `EISDIR`
* @G_SPAWN_ERROR_LIBBAD: execv() returned <literal>ELIBBAD</literal> * @G_SPAWN_ERROR_LIBBAD: execv() returned `ELIBBAD`
* @G_SPAWN_ERROR_FAILED: Some other fatal failure, * @G_SPAWN_ERROR_FAILED: Some other fatal failure,
* <literal>error-&gt;message</literal> should explain. * `error->message` should explain.
* *
* Error codes returned by spawning processes. * Error codes returned by spawning processes.
*/ */
@@ -124,51 +124,48 @@ typedef enum
* functions. * functions.
* *
* However, even on POSIX, you are extremely limited in what you can * However, even on POSIX, you are extremely limited in what you can
* safely do from a #GSpawnChildSetupFunc, because any mutexes that * safely do from a #GSpawnChildSetupFunc, because any mutexes that were
* were held by other threads in the parent process at the time of the * held by other threads in the parent process at the time of the fork()
* fork() will still be locked in the child process, and they will * will still be locked in the child process, and they will never be
* never be unlocked (since the threads that held them don't exist in * unlocked (since the threads that held them don't exist in the child).
* the child). POSIX allows only async-signal-safe functions (see * POSIX allows only async-signal-safe functions (see signal(7)) to be
* <citerefentry><refentrytitle>signal</refentrytitle><manvolnum>7</manvolnum></citerefentry>) * called in the child between fork() and exec(), which drastically limits
* to be called in the child between fork() and exec(), which * the usefulness of child setup functions.
* drastically limits the usefulness of child setup functions.
* *
* In particular, it is not safe to call any function which may * In particular, it is not safe to call any function which may
* call malloc(), which includes POSIX functions such as setenv(). * call malloc(), which includes POSIX functions such as setenv().
* If you need to set up the child environment differently from * If you need to set up the child environment differently from
* the parent, you should use g_get_environ(), g_environ_setenv(), * the parent, you should use g_get_environ(), g_environ_setenv(),
* and g_environ_unsetenv(), and then pass the complete environment * and g_environ_unsetenv(), and then pass the complete environment
* list to the <literal>g_spawn...</literal> function. * list to the `g_spawn...` function.
*/ */
typedef void (* GSpawnChildSetupFunc) (gpointer user_data); typedef void (* GSpawnChildSetupFunc) (gpointer user_data);
/** /**
* GSpawnFlags: * GSpawnFlags:
* @G_SPAWN_DEFAULT: no flags, default behaviour * @G_SPAWN_DEFAULT: no flags, default behaviour
* @G_SPAWN_LEAVE_DESCRIPTORS_OPEN: the parent's open file descriptors will be * @G_SPAWN_LEAVE_DESCRIPTORS_OPEN: the parent's open file descriptors will
* inherited by the child; otherwise all descriptors except stdin/stdout/stderr * be inherited by the child; otherwise all descriptors except stdin,
* will be closed before calling exec() in the child. * stdout and stderr will be closed before calling exec() in the child.
* @G_SPAWN_DO_NOT_REAP_CHILD: the child will not be automatically reaped; you * @G_SPAWN_DO_NOT_REAP_CHILD: the child will not be automatically reaped;
* must use g_child_watch_add() yourself (or call waitpid() * you must use g_child_watch_add() yourself (or call waitpid() or handle
* or handle <literal>SIGCHLD</literal> yourself), or the child will become a zombie. * `SIGCHLD` yourself), or the child will become a zombie.
* @G_SPAWN_SEARCH_PATH: <literal>argv[0]</literal> need not be an absolute path, * @G_SPAWN_SEARCH_PATH: `argv[0]` need not be an absolute path, it will be
* it will be looked for in the user's <envar>PATH</envar>. * looked for in the user's `PATH`.
* @G_SPAWN_STDOUT_TO_DEV_NULL: the child's standard output will be discarded, * @G_SPAWN_STDOUT_TO_DEV_NULL: the child's standard output will be discarded,
* instead of going to the same location as the parent's standard output. * instead of going to the same location as the parent's standard output.
* @G_SPAWN_STDERR_TO_DEV_NULL: the child's standard error will be discarded. * @G_SPAWN_STDERR_TO_DEV_NULL: the child's standard error will be discarded.
* @G_SPAWN_CHILD_INHERITS_STDIN: the child will inherit the parent's standard * @G_SPAWN_CHILD_INHERITS_STDIN: the child will inherit the parent's standard
* input (by default, the child's standard input is attached to * input (by default, the child's standard input is attached to `/dev/null`).
* <filename>/dev/null</filename>). * @G_SPAWN_FILE_AND_ARGV_ZERO: the first element of `argv` is the file to
* @G_SPAWN_FILE_AND_ARGV_ZERO: the first element of <literal>argv</literal> is * execute, while the remaining elements are the actual argument vector
* the file to execute, while the remaining elements are the actual argument * to pass to the file. Normally g_spawn_async_with_pipes() uses `argv[0]`
* vector to pass to the file. Normally g_spawn_async_with_pipes() uses * as the file to execute, and passes all of `argv` to the child.
* <literal>argv[0]</literal> as the file to execute, and passes all of * @G_SPAWN_SEARCH_PATH_FROM_ENVP: if `argv[0]` is not an abolute path,
* <literal>argv</literal> to the child. * it will be looked for in the `PATH` from the passed child environment.
* @G_SPAWN_SEARCH_PATH_FROM_ENVP: if <literal>argv[0]</literal> is not an abolute path, * Since: 2.34
* it will be looked for in the <envar>PATH</envar> from the passed child * @G_SPAWN_CLOEXEC_PIPES: create all pipes with the `O_CLOEXEC` flag set.
* environment. Since: 2.34 * Since: 2.40
* @G_SPAWN_CLOEXEC_PIPES: create all pipes with the O_CLOEXEC flag set.
* Since: 2.40.
* *
* Flags passed to g_spawn_sync(), g_spawn_async() and g_spawn_async_with_pipes(). * Flags passed to g_spawn_sync(), g_spawn_async() and g_spawn_async_with_pipes().
*/ */

5
gobject/gsignal.h
View File

@@ -192,9 +192,8 @@ typedef enum
* assume that instances thereof remain persistent across all signal emissions * assume that instances thereof remain persistent across all signal emissions
* they are used in. This is only useful for non ref-counted, value-copy types. * they are used in. This is only useful for non ref-counted, value-copy types.
* *
* To flag a signal argument in this way, add * To flag a signal argument in this way, add `| G_SIGNAL_TYPE_STATIC_SCOPE`
* <literal>| G_SIGNAL_TYPE_STATIC_SCOPE</literal> to the corresponding argument * to the corresponding argument of g_signal_new().
* of g_signal_new().
* |[ * |[
* g_signal_new ("size_request", * g_signal_new ("size_request",
* G_TYPE_FROM_CLASS (gobject_class), * G_TYPE_FROM_CLASS (gobject_class),

6
gobject/gtype.h
View File

@@ -57,7 +57,7 @@ G_BEGIN_DECLS
* G_TYPE_NONE: * G_TYPE_NONE:
* *
* A fundamental type which is used as a replacement for the C * A fundamental type which is used as a replacement for the C
* <literal>void</literal> return type. * void return type.
*/ */
#define G_TYPE_NONE G_TYPE_MAKE_FUNDAMENTAL (1) #define G_TYPE_NONE G_TYPE_MAKE_FUNDAMENTAL (1)
/** /**
@@ -1476,8 +1476,8 @@ guint g_type_get_type_registration_serial (void);
* function. * function.
* *
* The macro expects the interface initialization function to have the * The macro expects the interface initialization function to have the
* name <literal>t_n ## _default_init</literal>, and the interface * name `t_n ## _default_init`, and the interface structure to have the
* structure to have the name <literal>TN ## Interface</literal>. * name `TN ## Interface`.
* *
* Since: 2.24 * Since: 2.24
*/ */

6
gobject/gtypeplugin.h
View File

@@ -91,12 +91,10 @@ typedef void (*GTypePluginCompleteInterfaceInfo) (GTypePlugin *plugin,
* @unuse_plugin: Decreases the use count of the plugin. * @unuse_plugin: Decreases the use count of the plugin.
* @complete_type_info: Fills in the #GTypeInfo and * @complete_type_info: Fills in the #GTypeInfo and
* #GTypeValueTable structs for the type. The structs are initialized * #GTypeValueTable structs for the type. The structs are initialized
* with <literal>memset(s, 0, sizeof (s))</literal> before calling * with `memset(s, 0, sizeof (s))` before calling this function.
* this function.
* @complete_interface_info: Fills in missing parts of the #GInterfaceInfo * @complete_interface_info: Fills in missing parts of the #GInterfaceInfo
* for the interface. The structs is initialized with * for the interface. The structs is initialized with
* <literal>memset(s, 0, sizeof (s))</literal> before calling * `memset(s, 0, sizeof (s))` before calling this function.
* this function.
* *
* The #GTypePlugin interface is used by the type system in order to handle * The #GTypePlugin interface is used by the type system in order to handle
* the lifecycle of dynamically loaded types. * the lifecycle of dynamically loaded types.

7
gobject/gvalue.h
View File

@@ -173,10 +173,9 @@ void g_value_register_transform_func (GType src_type,
/** /**
* G_VALUE_INIT: * G_VALUE_INIT:
* *
* A #GValue must be initialized before it can be used. * A #GValue must be initialized before it can be used. This macro can
* This macro can be used as initializer instead of an explicit * be used as initializer instead of an explicit `{ 0 }` when declaring
* <literal>{ 0 }</literal> when declaring a variable, * a variable, but it cannot be assigned to a variable.
* but it cannot be assigned to a variable.
* *
* |[ * |[
* GValue value = G_VALUE_INIT; * GValue value = G_VALUE_INIT;