[glibmm] Regenerate docs XML.
- From: Murray Cumming <murrayc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glibmm] Regenerate docs XML.
- Date: Tue, 4 Mar 2014 09:02:01 +0000 (UTC)
commit cafdfeb649e385f5be6db360800453fb122e531c
Author: Murray Cumming <murrayc murrayc com>
Date: Tue Mar 4 10:01:52 2014 +0100
Regenerate docs XML.
gio/src/gio_docs.xml | 17 +++----
glib/src/glib_docs.xml | 118 +++++++++++++++++++++++------------------------
2 files changed, 66 insertions(+), 69 deletions(-)
---
diff --git a/gio/src/gio_docs.xml b/gio/src/gio_docs.xml
index 281e8ee..9e25bfd 100644
--- a/gio/src/gio_docs.xml
+++ b/gio/src/gio_docs.xml
@@ -3437,12 +3437,12 @@ reported for the toplevel file.
<parameter_description> Tally usage based on apparent file
sizes. Normally, the block-size is used, if available, as this is a
more accurate representation of disk space used.
-Compare with '<literal>du --apparent-size</literal>'.
+Compare with `du --apparent-size`.
</parameter_description>
</parameter>
<parameter name="G_FILE_MEASURE_NO_XDEV">
<parameter_description> Do not cross mount point boundaries.
-Compare with '<literal>du -x</literal>'.
+Compare with `du -x`.
</parameter_description>
</parameter>
</parameters>
@@ -4575,7 +4575,7 @@ directions.
</description>
<parameters>
<parameter name="G_SETTINGS_BIND_DEFAULT">
-<parameter_description> Equivalent to <literal>G_SETTINGS_BIND_GET|G_SETTINGS_BIND_SET</literal>
+<parameter_description> Equivalent to `G_SETTINGS_BIND_GET|G_SETTINGS_BIND_SET`
</parameter_description>
</parameter>
<parameter name="G_SETTINGS_BIND_GET">
@@ -5448,12 +5448,11 @@ indicates a socket not bound to any name (eg, a client-side socket,
or a socket created with socketpair()).
For abstract sockets, there are two incompatible ways of naming
-them; the man pages suggest using the entire <literal>struct
-sockaddr_un</literal> as the name, padding the unused parts of the
-%sun_path field with zeroes; this corresponds to
-%G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED. However, many programs
-instead just use a portion of %sun_path, and pass an appropriate
-smaller length to bind() or connect(). This is
+them; the man pages suggest using the entire `struct sockaddr_un`
+as the name, padding the unused parts of the %sun_path field with
+zeroes; this corresponds to %G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED.
+However, many programs instead just use a portion of %sun_path, and
+pass an appropriate smaller length to bind() or connect(). This is
%G_UNIX_SOCKET_ADDRESS_ABSTRACT.
Since: 2.26
diff --git a/glib/src/glib_docs.xml b/glib/src/glib_docs.xml
index 2c949a0..f7dbd12 100644
--- a/glib/src/glib_docs.xml
+++ b/glib/src/glib_docs.xml
@@ -985,7 +985,7 @@ Flags that affect the behaviour of the parser.
<parameter_description> When this flag is set, CDATA marked
sections are not passed literally to the @passthrough function of
the parser. Instead, the content of the section (without the
-<literal><![CDATA[</literal> and <literal>]]></literal>) is
+`<![CDATA[` and `]]>`) is
passed to the @text function. This flag was added in GLib 2.12
</parameter_description>
</parameter>
@@ -1147,10 +1147,9 @@ Since: 2.4
<enum name="GOptionArg">
<description>
The #GOptionArg enum values determine which type of extra argument the
-options expect to find. If an option expects an extra argument, it
-can be specified in several ways; with a short option:
-<option>-x arg</option>, with a long option: <option>--name arg</option>
-or combined in a single argument: <option>--name=arg</option>.
+options expect to find. If an option expects an extra argument, it can
+be specified in several ways; with a short option: `-x arg`, with a long
+option: `--name arg` or combined in a single argument: `--name=arg`.
</description>
<parameters>
@@ -1187,14 +1186,15 @@ multiple uses of the option are collected into an array of strings.
</parameter>
<parameter name="G_OPTION_ARG_DOUBLE">
<parameter_description> 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.
+Since 2.12
</parameter_description>
</parameter>
<parameter name="G_OPTION_ARG_INT64">
-<parameter_description> 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
+<parameter_description> 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
</parameter_description>
</parameter>
</parameters>
@@ -1230,18 +1230,17 @@ Flags which modify individual options.
</description>
<parameters>
<parameter name="G_OPTION_FLAG_HIDDEN">
-<parameter_description> The option doesn't appear in <option>--help</option>
-output.
+<parameter_description> The option doesn't appear in `--help` output.
</parameter_description>
</parameter>
<parameter name="G_OPTION_FLAG_IN_MAIN">
<parameter_description> 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.
</parameter_description>
</parameter>
<parameter name="G_OPTION_FLAG_REVERSE">
-<parameter_description> For options of the %G_OPTION_ARG_NONE kind, this flag
-indicates that the sense of the option is reversed.
+<parameter_description> For options of the %G_OPTION_ARG_NONE kind, this
+flag indicates that the sense of the option is reversed.
</parameter_description>
</parameter>
<parameter name="G_OPTION_FLAG_NO_ARG">
@@ -1258,17 +1257,18 @@ callback in the GLib filename encoding rather than UTF-8. Since 2.8
</parameter>
<parameter name="G_OPTION_FLAG_OPTIONAL_ARG">
<parameter_description> For options of the %G_OPTION_ARG_CALLBACK
-kind, this flag indicates that the argument supply is optional. If no argument
-is given then data of %GOptionParseFunc will be set to NULL. Since 2.8
+kind, this flag indicates that the argument supply is optional.
+If no argument is given then data of %GOptionParseFunc will be
+set to NULL. Since 2.8
</parameter_description>
</parameter>
<parameter name="G_OPTION_FLAG_NOALIAS">
-<parameter_description> This flag turns off the automatic conflict resolution
-which prefixes long option names with <literal>groupname-</literal> if
-there is a conflict. This option should only be used in situations where
-aliasing is necessary to model some legacy commandline interface. It is
-not safe to use this option, unless all option groups are under your
-direct control. Since 2.8.
+<parameter_description> This flag turns off the automatic conflict
+resolution which prefixes long option names with `groupname-` if
+there is a conflict. This option should only be used in situations
+where aliasing is necessary to model some legacy commandline interface.
+It is not safe to use this option, unless all option groups are under
+your direct control. Since 2.8.
</parameter_description>
</parameter>
</parameters>
@@ -2023,15 +2023,15 @@ Error codes returned by spawning processes.
</parameter_description>
</parameter>
<parameter name="G_SPAWN_ERROR_ACCES">
-<parameter_description> execv() returned <literal>EACCES</literal>
+<parameter_description> execv() returned `EACCES`
</parameter_description>
</parameter>
<parameter name="G_SPAWN_ERROR_PERM">
-<parameter_description> execv() returned <literal>EPERM</literal>
+<parameter_description> execv() returned `EPERM`
</parameter_description>
</parameter>
<parameter name="G_SPAWN_ERROR_TOO_BIG">
-<parameter_description> execv() returned <literal>E2BIG</literal>
+<parameter_description> execv() returned `E2BIG`
</parameter_description>
</parameter>
<parameter name="G_SPAWN_ERROR_2BIG">
@@ -2039,60 +2039,60 @@ Error codes returned by spawning processes.
</parameter_description>
</parameter>
<parameter name="G_SPAWN_ERROR_NOEXEC">
-<parameter_description> execv() returned <literal>ENOEXEC</literal>
+<parameter_description> execv() returned `ENOEXEC`
</parameter_description>
</parameter>
<parameter name="G_SPAWN_ERROR_NAMETOOLONG">
-<parameter_description> execv() returned <literal>ENAMETOOLONG</literal>
+<parameter_description> execv() returned `ENAMETOOLONG`
</parameter_description>
</parameter>
<parameter name="G_SPAWN_ERROR_NOENT">
-<parameter_description> execv() returned <literal>ENOENT</literal>
+<parameter_description> execv() returned `ENOENT`
</parameter_description>
</parameter>
<parameter name="G_SPAWN_ERROR_NOMEM">
-<parameter_description> execv() returned <literal>ENOMEM</literal>
+<parameter_description> execv() returned `ENOMEM`
</parameter_description>
</parameter>
<parameter name="G_SPAWN_ERROR_NOTDIR">
-<parameter_description> execv() returned <literal>ENOTDIR</literal>
+<parameter_description> execv() returned `ENOTDIR`
</parameter_description>
</parameter>
<parameter name="G_SPAWN_ERROR_LOOP">
-<parameter_description> execv() returned <literal>ELOOP</literal>
+<parameter_description> execv() returned `ELOOP`
</parameter_description>
</parameter>
<parameter name="G_SPAWN_ERROR_TXTBUSY">
-<parameter_description> execv() returned <literal>ETXTBUSY</literal>
+<parameter_description> execv() returned `ETXTBUSY`
</parameter_description>
</parameter>
<parameter name="G_SPAWN_ERROR_IO">
-<parameter_description> execv() returned <literal>EIO</literal>
+<parameter_description> execv() returned `EIO`
</parameter_description>
</parameter>
<parameter name="G_SPAWN_ERROR_NFILE">
-<parameter_description> execv() returned <literal>ENFILE</literal>
+<parameter_description> execv() returned `ENFILE`
</parameter_description>
</parameter>
<parameter name="G_SPAWN_ERROR_MFILE">
-<parameter_description> execv() returned <literal>EMFILE</literal>
+<parameter_description> execv() returned `EMFILE`
</parameter_description>
</parameter>
<parameter name="G_SPAWN_ERROR_INVAL">
-<parameter_description> execv() returned <literal>EINVAL</literal>
+<parameter_description> execv() returned `EINVAL`
</parameter_description>
</parameter>
<parameter name="G_SPAWN_ERROR_ISDIR">
-<parameter_description> execv() returned <literal>EISDIR</literal>
+<parameter_description> execv() returned `EISDIR`
</parameter_description>
</parameter>
<parameter name="G_SPAWN_ERROR_LIBBAD">
-<parameter_description> execv() returned <literal>ELIBBAD</literal>
+<parameter_description> execv() returned `ELIBBAD`
</parameter_description>
</parameter>
<parameter name="G_SPAWN_ERROR_FAILED">
<parameter_description> Some other fatal failure,
-<literal>error->message</literal> should explain.
+`error->message` should explain.
</parameter_description>
</parameter>
</parameters>
@@ -2109,20 +2109,20 @@ Flags passed to g_spawn_sync(), g_spawn_async() and g_spawn_async_with_pipes().
</parameter_description>
</parameter>
<parameter name="G_SPAWN_LEAVE_DESCRIPTORS_OPEN">
-<parameter_description> the parent's open file descriptors will be
-inherited by the child; otherwise all descriptors except stdin/stdout/stderr
-will be closed before calling exec() in the child.
+<parameter_description> the parent's open file descriptors will
+be inherited by the child; otherwise all descriptors except stdin,
+stdout and stderr will be closed before calling exec() in the child.
</parameter_description>
</parameter>
<parameter name="G_SPAWN_DO_NOT_REAP_CHILD">
-<parameter_description> the child will not be automatically reaped; you
-must use g_child_watch_add() yourself (or call waitpid()
-or handle <literal>SIGCHLD</literal> yourself), or the child will become a zombie.
+<parameter_description> the child will not be automatically reaped;
+you must use g_child_watch_add() yourself (or call waitpid() or handle
+`SIGCHLD` yourself), or the child will become a zombie.
</parameter_description>
</parameter>
<parameter name="G_SPAWN_SEARCH_PATH">
-<parameter_description> <literal>argv[0]</literal> need not be an absolute path,
-it will be looked for in the user's <envar>PATH</envar>.
+<parameter_description> `argv[0]` need not be an absolute path, it will be
+looked for in the user's `PATH`.
</parameter_description>
</parameter>
<parameter name="G_SPAWN_STDOUT_TO_DEV_NULL">
@@ -2136,27 +2136,25 @@ instead of going to the same location as the parent's standard output.
</parameter>
<parameter name="G_SPAWN_CHILD_INHERITS_STDIN">
<parameter_description> the child will inherit the parent's standard
-input (by default, the child's standard input is attached to
-<filename>/dev/null</filename>).
+input (by default, the child's standard input is attached to `/dev/null`).
</parameter_description>
</parameter>
<parameter name="G_SPAWN_FILE_AND_ARGV_ZERO">
-<parameter_description> the first element of <literal>argv</literal> is
-the file to execute, while the remaining elements are the actual argument
-vector to pass to the file. Normally g_spawn_async_with_pipes() uses
-<literal>argv[0]</literal> as the file to execute, and passes all of
-<literal>argv</literal> to the child.
+<parameter_description> the first element of `argv` is the file to
+execute, while the remaining elements are the actual argument vector
+to pass to the file. Normally g_spawn_async_with_pipes() uses `argv[0]`
+as the file to execute, and passes all of `argv` to the child.
</parameter_description>
</parameter>
<parameter name="G_SPAWN_SEARCH_PATH_FROM_ENVP">
-<parameter_description> if <literal>argv[0]</literal> is not an abolute path,
-it will be looked for in the <envar>PATH</envar> from the passed child
-environment. Since: 2.34
+<parameter_description> if `argv[0]` is not an abolute path,
+it will be looked for in the `PATH` from the passed child environment.
+Since: 2.34
</parameter_description>
</parameter>
<parameter name="G_SPAWN_CLOEXEC_PIPES">
-<parameter_description> create all pipes with the O_CLOEXEC flag set.
-Since: 2.40.
+<parameter_description> create all pipes with the `O_CLOEXEC` flag set.
+Since: 2.40
</parameter_description>
</parameter>
</parameters>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
