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

Docs: Drop entities, switch away from sgml mode

Browse Source 
Since all element markup is now gone from the doc comments,
we can turn off the gtk-doc sgml mode, which means that from
now on, docbook markup is no longer allowed in doc comments.

To make this possible, we have to replace all remaining
entities in doc comments by their replacement text, & -> &
and so on.
This commit is contained in:
Matthias Clasen 2014-02-09 02:07:26 -05:00
parent a03cee3b27
commit 35066ed6c6
39 changed files with 104 additions and 103 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/reference/gio/Makefile.am
View File

@ -99,7 +99,7 @@ GTKDOC_LIBS = \
$(NULL) $(NULL)
# Extra options to supply to gtkdoc-mkdb # Extra options to supply to gtkdoc-mkdb
MKDB_OPTIONS = --output-format=xml --sgml-mode --name-space=g \ MKDB_OPTIONS = --output-format=xml --name-space=g \
--ignore-files='libasyncns tests' --ignore-files='libasyncns tests'
# Images to copy into HTML directory # Images to copy into HTML directory

2
docs/reference/glib/Makefile.am
View File

@ -15,7 +15,7 @@ DOC_SOURCE_DIR=$(top_srcdir)/glib $(top_srcdir)/gmodule
SCAN_OPTIONS=--deprecated-guards="G_DISABLE_DEPRECATED" --ignore-decorators="GLIB_VAR|G_GNUC_WARN_UNUSED_RESULT" SCAN_OPTIONS=--deprecated-guards="G_DISABLE_DEPRECATED" --ignore-decorators="GLIB_VAR|G_GNUC_WARN_UNUSED_RESULT"
# Extra options to supply to gtkdoc-mkdb # Extra options to supply to gtkdoc-mkdb
MKDB_OPTIONS=--sgml-mode --output-format=xml --name-space=g MKDB_OPTIONS=--output-format=xml --name-space=g
# Used for dependencies # Used for dependencies
HFILE_GLOB=$(top_srcdir)/glib/*.h $(top_srcdir)/gmodule/*.h HFILE_GLOB=$(top_srcdir)/glib/*.h $(top_srcdir)/gmodule/*.h

2
docs/reference/gobject/Makefile.am
View File

@ -16,7 +16,7 @@ SCAN_OPTIONS=--deprecated-guards="G_DISABLE_DEPRECATED" \
--ignore-decorators="G_GNUC_INTERNAL|G_GNUC_WARN_UNUSED_RESULT" --ignore-decorators="G_GNUC_INTERNAL|G_GNUC_WARN_UNUSED_RESULT"
# Extra options to supply to gtkdoc-mkdb # Extra options to supply to gtkdoc-mkdb
MKDB_OPTIONS=--sgml-mode --output-format=xml --name-space=g MKDB_OPTIONS=--output-format=xml --name-space=g
# Used for dependencies # Used for dependencies
HFILE_GLOB=$(top_srcdir)/gobject/*.h HFILE_GLOB=$(top_srcdir)/gobject/*.h

2
gio/gappinfo.c
View File

@ -41,7 +41,7 @@
* (using g_file_get_path()) when using g_app_info_launch() even if * (using g_file_get_path()) when using g_app_info_launch() even if
* the application requested an URI and not a POSIX path. For example * the application requested an URI and not a POSIX path. For example
* for an desktop-file based application with Exec key `totem * for an desktop-file based application with Exec key `totem
* %U` and a single URI, `sftp://foo/file.avi`, then * \%U` and a single URI, `sftp://foo/file.avi`, then
* `/home/user/.gvfs/sftp on foo/file.avi` will be passed. This will * `/home/user/.gvfs/sftp on foo/file.avi` will be passed. This will
* only work if a set of suitable GIO extensions (such as gvfs 2.26 * only work if a set of suitable GIO extensions (such as gvfs 2.26
* compiled with FUSE support), is available and operational; if this * compiled with FUSE support), is available and operational; if this

2
gio/gdbusaddress.c
View File

@ -60,7 +60,7 @@
* *
* Routines for working with D-Bus addresses. A D-Bus address is a string * Routines for working with D-Bus addresses. A D-Bus address is a string
* like "unix:tmpdir=/tmp/my-app-name". The exact format of addresses * like "unix:tmpdir=/tmp/my-app-name". The exact format of addresses
* is explained in detail in the [D-Bus specification](http://dbus.freedesktop.org/doc/dbus-specification.html#addresses). * is explained in detail in the [D-Bus specification](http://dbus.freedesktop.org/doc/dbus-specification.html\#addresses).
*/ */
static gchar *get_session_address_platform_specific (GError **error); static gchar *get_session_address_platform_specific (GError **error);

2
gio/gdbusintrospection.c
View File

@ -1757,7 +1757,7 @@ parser_error (GMarkupParseContext *context,
* Parses @xml_data and returns a #GDBusNodeInfo representing the data. * Parses @xml_data and returns a #GDBusNodeInfo representing the data.
* *
* The introspection XML must contain exactly one top-level * The introspection XML must contain exactly one top-level
* &lt;node&gt; element. * <node> element.
* *
* Note that this routine is using a * Note that this routine is using a
* [GMarkup][glib-Simple-XML-Subset-Parser.description]-based * [GMarkup][glib-Simple-XML-Subset-Parser.description]-based

2
gio/gdesktopappinfo.c
View File

@ -58,7 +58,7 @@
* #GDesktopAppInfo is an implementation of #GAppInfo based on * #GDesktopAppInfo is an implementation of #GAppInfo based on
* desktop files. * desktop files.
* *
* Note that `&lt;gio/gdesktopappinfo.h&gt;` belongs to the UNIX-specific * Note that `<gio/gdesktopappinfo.h>` belongs to the UNIX-specific
* GIO interfaces, thus you have to use the `gio-unix-2.0.pc` pkg-config * GIO interfaces, thus you have to use the `gio-unix-2.0.pc` pkg-config
* file when using it. * file when using it.
*/ */

2
gio/gfileattribute.c
View File

@ -321,7 +321,7 @@ escape_byte_string (const char *str)
* Converts a #GFileAttributeValue to a string for display. * Converts a #GFileAttributeValue to a string for display.
* The returned string should be freed when no longer needed. * The returned string should be freed when no longer needed.
* *
* Returns: a string from the @attr, %NULL on error, or "&lt;invalid&gt;" * Returns: a string from the @attr, %NULL on error, or "<invalid>"
* if @attr is of type %G_FILE_ATTRIBUTE_TYPE_INVALID. * if @attr is of type %G_FILE_ATTRIBUTE_TYPE_INVALID.
*/ */
char * char *

2
gio/gfiledescriptorbased.c
View File

@ -32,7 +32,7 @@
* #GFileDescriptorBased is implemented by streams (implementations of * #GFileDescriptorBased is implemented by streams (implementations of
* #GInputStream or #GOutputStream) that are based on file descriptors. * #GInputStream or #GOutputStream) that are based on file descriptors.
* *
* Note that `&lt;gio/gfiledescriptorbased.h&gt;` belongs to the UNIX-specific * Note that `<gio/gfiledescriptorbased.h>` belongs to the UNIX-specific
* GIO interfaces, thus you have to use the `gio-unix-2.0.pc` pkg-config * GIO interfaces, thus you have to use the `gio-unix-2.0.pc` pkg-config
* file when using it. * file when using it.
* *

2
gio/gicon.c
View File

@ -197,7 +197,7 @@ g_icon_to_string_tokenized (GIcon *icon, GString *s)
* (such as `/path/to/my icon.png`) without escaping * (such as `/path/to/my icon.png`) without escaping
* if the #GFile for @icon is a native file. If the file is not * if the #GFile for @icon is a native file. If the file is not
* native, the returned string is the result of g_file_get_uri() * native, the returned string is the result of g_file_get_uri()
* (such as `sftp://path/to/my&percnt;20icon.png`). * (such as `sftp://path/to/my\%20icon.png`).
* *
* - If @icon is a #GThemedIcon with exactly one name, the encoding is * - If @icon is a #GThemedIcon with exactly one name, the encoding is
* simply the name (such as `network-server`). * simply the name (such as `network-server`).

2
gio/gmenumodel.c
View File

@ -571,7 +571,7 @@ g_menu_model_get_item_attribute_value (GMenuModel *model,
* g_variant_get(), followed by a g_variant_unref(). As such, * g_variant_get(), followed by a g_variant_unref(). As such,
* @format_string must make a complete copy of the data (since the * @format_string must make a complete copy of the data (since the
* #GVariant may go away after the call to g_variant_unref()). In * #GVariant may go away after the call to g_variant_unref()). In
* particular, no '&amp;' characters are allowed in @format_string. * particular, no '&' characters are allowed in @format_string.
* *
* Returns: %TRUE if the named attribute was found with the expected * Returns: %TRUE if the named attribute was found with the expected
* type * type

2
gio/gnetworking.c
View File

@ -28,7 +28,7 @@
* @short_description: System networking includes * @short_description: System networking includes
* @include: gio/gnetworking.h * @include: gio/gnetworking.h
* *
* The `&lt;gio/gnetworking.h&gt;` header can be included to get * The `<gio/gnetworking.h>` header can be included to get
* various low-level networking-related system headers, automatically * various low-level networking-related system headers, automatically
* taking care of certain portability issues for you. * taking care of certain portability issues for you.
* *

4
gio/gproxyresolver.c
View File

@ -98,8 +98,8 @@ g_proxy_resolver_is_supported (GProxyResolver *resolver)
* *
* Looks into the system proxy configuration to determine what proxy, * Looks into the system proxy configuration to determine what proxy,
* if any, to use to connect to @uri. The returned proxy URIs are of * if any, to use to connect to @uri. The returned proxy URIs are of
* the form `&lt;protocol&gt;://[user[:password]@]host:port` or * the form `<protocol>://[user[:password]@]host:port` or
* `direct://`, where &lt;protocol&gt; could be http, rtsp, socks * `direct://`, where <protocol> could be http, rtsp, socks
* or other proxying protocol. * or other proxying protocol.
* *
* If you don't know what network protocol is being used on the * If you don't know what network protocol is being used on the

12
gio/gsettings.c
View File

@ -86,9 +86,9 @@
* Similar to GConf, the default values in GSettings schemas can be * Similar to GConf, the default values in GSettings schemas can be
* localized, but the localized values are stored in gettext catalogs * localized, but the localized values are stored in gettext catalogs
* and looked up with the domain that is specified in the * and looked up with the domain that is specified in the
* gettext-domain attribute of the &lt;schemalist&gt; or &lt;schema&gt; * gettext-domain attribute of the <schemalist> or <schema>
* elements and the category that is specified in the l10n attribute of * elements and the category that is specified in the l10n attribute of
* the &lt;key&gt; element. * the <key> element.
* *
* GSettings uses schemas in a compact binary form that is created * GSettings uses schemas in a compact binary form that is created
* by the [glib-compile-schemas][glib-compile-schemas] * by the [glib-compile-schemas][glib-compile-schemas]
@ -101,7 +101,7 @@
* files to have the extension `.gschema.xml`. * files to have the extension `.gschema.xml`.
* *
* At runtime, schemas are identified by their id (as specified in the * At runtime, schemas are identified by their id (as specified in the
* id attribute of the &lt;schema&gt; element). The convention for schema * id attribute of the <schema> element). The convention for schema
* ids is to use a dotted name, similar in style to a D-Bus bus name, * ids is to use a dotted name, similar in style to a D-Bus bus name,
* e.g. "org.gnome.SessionManager". In particular, if the settings are * e.g. "org.gnome.SessionManager". In particular, if the settings are
* for a specific service that owns a D-Bus bus name, the D-Bus bus name * for a specific service that owns a D-Bus bus name, the D-Bus bus name
@ -110,8 +110,8 @@
* StudlyCaps, e.g. "org.gnome.font-rendering". * StudlyCaps, e.g. "org.gnome.font-rendering".
* *
* In addition to #GVariant types, keys can have types that have * In addition to #GVariant types, keys can have types that have
* enumerated types. These can be described by a &lt;choice&gt;, * enumerated types. These can be described by a <choice>,
* &lt;enum&gt; or &lt;flags&gt; element, as seen in the * <enum> or <flags> element, as seen in the
* [example][schema-enumerated]. The underlying type of such a key * [example][schema-enumerated]. The underlying type of such a key
* is string, but you can use g_settings_get_enum(), g_settings_set_enum(), * is string, but you can use g_settings_get_enum(), g_settings_set_enum(),
* g_settings_get_flags(), g_settings_set_flags() access the numeric values * g_settings_get_flags(), g_settings_set_flags() access the numeric values
@ -2178,7 +2178,7 @@ g_settings_is_writable (GSettings *settings,
* @settings. * @settings.
* *
* The schema for the child settings object must have been declared * The schema for the child settings object must have been declared
* in the schema of @settings using a &lt;child&gt; element. * in the schema of @settings using a <child> element.
* *
* Returns: (transfer full): a 'child' settings object * Returns: (transfer full): a 'child' settings object
* *

6
gio/gsocket.c
View File

@ -68,7 +68,7 @@
* SECTION:gsocket * SECTION:gsocket
* @short_description: Low-level socket object * @short_description: Low-level socket object
* @include: gio/gio.h * @include: gio/gio.h
* @see_also: #GInitable, [&lt;gnetworking.h&gt;][gio-gnetworking.h] * @see_also: #GInitable, [<gnetworking.h>][gio-gnetworking.h]
* *
* A #GSocket is a low-level networking primitive. It is a more or less * A #GSocket is a low-level networking primitive. It is a more or less
* direct mapping of the BSD socket API in a portable GObject based API. * direct mapping of the BSD socket API in a portable GObject based API.
@ -4516,7 +4516,7 @@ g_socket_get_credentials (GSocket *socket,
* getsockopt(). (If you need to fetch a non-integer-valued option, * getsockopt(). (If you need to fetch a non-integer-valued option,
* you will need to call getsockopt() directly.) * you will need to call getsockopt() directly.)
* *
* The [&lt;gio/gnetworking.h&gt;][gio-gnetworking.h] * The [<gio/gnetworking.h>][gio-gnetworking.h]
* header pulls in system headers that will define most of the * header pulls in system headers that will define most of the
* standard/portable socket options. For unusual socket protocols or * standard/portable socket options. For unusual socket protocols or
* platform-dependent options, you may need to include additional * platform-dependent options, you may need to include additional
@ -4583,7 +4583,7 @@ g_socket_get_option (GSocket *socket,
* setsockopt(). (If you need to set a non-integer-valued option, * setsockopt(). (If you need to set a non-integer-valued option,
* you will need to call setsockopt() directly.) * you will need to call setsockopt() directly.)
* *
* The [&lt;gio/gnetworking.h&gt;][gio-gnetworking.h] * The [<gio/gnetworking.h>][gio-gnetworking.h]
* header pulls in system headers that will define most of the * header pulls in system headers that will define most of the
* standard/portable socket options. For unusual socket protocols or * standard/portable socket options. For unusual socket protocols or
* platform-dependent options, you may need to include additional * platform-dependent options, you may need to include additional

2
gio/gunixconnection.c
View File

@ -39,7 +39,7 @@
* It contains functions to do some of the UNIX socket specific * It contains functions to do some of the UNIX socket specific
* functionality like passing file descriptors. * functionality like passing file descriptors.
* *
* Note that `&lt;gio/gunixconnection.h&gt;` belongs to the UNIX-specific * Note that `<gio/gunixconnection.h>` belongs to the UNIX-specific
* GIO interfaces, thus you have to use the `gio-unix-2.0.pc` * GIO interfaces, thus you have to use the `gio-unix-2.0.pc`
* pkg-config file when using it. * pkg-config file when using it.
* *

2
gio/gunixfdlist.c
View File

@ -26,7 +26,7 @@
* the %G_SOCKET_ADDRESS_UNIX family by using g_socket_send_message() * the %G_SOCKET_ADDRESS_UNIX family by using g_socket_send_message()
* and received using g_socket_receive_message(). * and received using g_socket_receive_message().
* *
* Note that `&lt;gio/gunixfdlist.h&gt;` belongs to the UNIX-specific GIO * Note that `<gio/gunixfdlist.h>` belongs to the UNIX-specific GIO
* interfaces, thus you have to use the `gio-unix-2.0.pc` pkg-config * interfaces, thus you have to use the `gio-unix-2.0.pc` pkg-config
* file when using it. * file when using it.
*/ */

2
gio/gunixfdmessage.c
View File

@ -29,7 +29,7 @@
* stream-oriented UNIX sockets, see g_unix_connection_send_fd() and * stream-oriented UNIX sockets, see g_unix_connection_send_fd() and
* g_unix_connection_receive_fd(). * g_unix_connection_receive_fd().
* *
* Note that `&lt;gio/gunixfdmessage.h&gt;` belongs to the UNIX-specific GIO * Note that `<gio/gunixfdmessage.h>` belongs to the UNIX-specific GIO
* interfaces, thus you have to use the `gio-unix-2.0.pc` pkg-config * interfaces, thus you have to use the `gio-unix-2.0.pc` pkg-config
* file when using it. * file when using it.
*/ */

2
gio/gunixinputstream.c
View File

@ -51,7 +51,7 @@
* asynchronous I/O. If it refers to a regular file, it will fall back * asynchronous I/O. If it refers to a regular file, it will fall back
* to doing asynchronous I/O in another thread.) * to doing asynchronous I/O in another thread.)
* *
* Note that `&lt;gio/gunixinputstream.h&gt;` belongs to the UNIX-specific GIO * Note that `<gio/gunixinputstream.h>` belongs to the UNIX-specific GIO
* interfaces, thus you have to use the `gio-unix-2.0.pc` pkg-config * interfaces, thus you have to use the `gio-unix-2.0.pc` pkg-config
* file when using it. * file when using it.
*/ */

2
gio/gunixmounts.c
View File

@ -79,7 +79,7 @@ static const char *_resolve_dev_root (void);
* *
* Routines for managing mounted UNIX mount points and paths. * Routines for managing mounted UNIX mount points and paths.
* *
* Note that `&lt;gio/gunixmounts.h&gt;` belongs to the UNIX-specific GIO * Note that `<gio/gunixmounts.h>` belongs to the UNIX-specific GIO
* interfaces, thus you have to use the `gio-unix-2.0.pc` pkg-config * interfaces, thus you have to use the `gio-unix-2.0.pc` pkg-config
* file when using it. * file when using it.
*/ */

2
gio/gunixoutputstream.c
View File

@ -51,7 +51,7 @@
* asynchronous I/O. If it refers to a regular file, it will fall back * asynchronous I/O. If it refers to a regular file, it will fall back
* to doing asynchronous I/O in another thread.) * to doing asynchronous I/O in another thread.)
* *
* Note that `&lt;gio/gunixoutputstream.h&gt;` belongs to the UNIX-specific GIO * Note that `<gio/gunixoutputstream.h>` belongs to the UNIX-specific GIO
* interfaces, thus you have to use the `gio-unix-2.0.pc` pkg-config file * interfaces, thus you have to use the `gio-unix-2.0.pc` pkg-config file
* when using it. * when using it.
*/ */

2
gio/gunixsocketaddress.c
View File

@ -44,7 +44,7 @@
* errors. You can use g_unix_socket_address_abstract_names_supported() * errors. You can use g_unix_socket_address_abstract_names_supported()
* to see if abstract names are supported. * to see if abstract names are supported.
* *
* Note that `&lt;gio/gunixsocketaddress.h&gt;` belongs to the UNIX-specific GIO * Note that `<gio/gunixsocketaddress.h>` belongs to the UNIX-specific GIO
* interfaces, thus you have to use the `gio-unix-2.0.pc` pkg-config file * interfaces, thus you have to use the `gio-unix-2.0.pc` pkg-config file
* when using it. * when using it.
*/ */

2
gio/gwin32inputstream.c
View File

@ -44,7 +44,7 @@
* #GWin32InputStream implements #GInputStream for reading from a * #GWin32InputStream implements #GInputStream for reading from a
* Windows file handle. * Windows file handle.
* *
* Note that `&lt;gio/gwin32inputstream.h&gt;` belongs to the Windows-specific GIO * Note that `<gio/gwin32inputstream.h>` belongs to the Windows-specific GIO
* interfaces, thus you have to use the `gio-windows-2.0.pc` pkg-config file * interfaces, thus you have to use the `gio-windows-2.0.pc` pkg-config file
* when using it. * when using it.
*/ */

2
gio/gwin32outputstream.c
View File

@ -45,7 +45,7 @@
* #GWin32OutputStream implements #GOutputStream for writing to a * #GWin32OutputStream implements #GOutputStream for writing to a
* Windows file handle. * Windows file handle.
* *
* Note that `&lt;gio/gwin32outputstream.h&gt;` belongs to the Windows-specific GIO * Note that `<gio/gwin32outputstream.h>` belongs to the Windows-specific GIO
* interfaces, thus you have to use the `gio-windows-2.0.pc` pkg-config file * interfaces, thus you have to use the `gio-windows-2.0.pc` pkg-config file
* when using it. * when using it.
*/ */

4
glib/docs.c
View File

@ -1526,14 +1526,14 @@
* G_OS_WIN32: * G_OS_WIN32:
* *
* This macro is defined only on Windows. So you can bracket * This macro is defined only on Windows. So you can bracket
* Windows-specific code in "&num;ifdef G_OS_WIN32". * Windows-specific code in "\#ifdef G_OS_WIN32".
*/ */
/** /**
* G_OS_UNIX: * G_OS_UNIX:
* *
* This macro is defined only on UNIX. So you can bracket * This macro is defined only on UNIX. So you can bracket
* UNIX-specific code in "&num;ifdef G_OS_UNIX". * UNIX-specific code in "\#ifdef G_OS_UNIX".
*/ */
/** /**

6
glib/gbookmarkfile.c
View File

@ -66,11 +66,11 @@
* Desktop Bookmark Specification, here is a quick summary: bookmark * Desktop Bookmark Specification, here is a quick summary: bookmark
* files use a sub-class of the XML Bookmark Exchange Language * files use a sub-class of the XML Bookmark Exchange Language
* specification, consisting of valid UTF-8 encoded XML, under the * specification, consisting of valid UTF-8 encoded XML, under the
* &lt;xbel&gt; root element; each bookmark is stored inside a * <xbel> root element; each bookmark is stored inside a
* &lt;bookmark&gt; element, using its URI: no relative paths can * <bookmark> element, using its URI: no relative paths can
* be used inside a bookmark file. The bookmark may have a user defined * be used inside a bookmark file. The bookmark may have a user defined
* title and description, to be used instead of the URI. Under the * title and description, to be used instead of the URI. Under the
* &lt;metadata&gt; element, with its owner attribute set to * <metadata> element, with its owner attribute set to
* `http://freedesktop.org`, is stored the meta-data about a resource * `http://freedesktop.org`, is stored the meta-data about a resource
* pointed by its URI. The meta-data consists of the resource's MIME * pointed by its URI. The meta-data consists of the resource's MIME
* type; the applications that have registered a bookmark; the groups * type; the applications that have registered a bookmark; the groups

12
glib/gerror.c
View File

@ -243,7 +243,7 @@
* *
* Error domains and codes are conventionally named as follows: * Error domains and codes are conventionally named as follows:
* *
* - The error domain is called &lt;NAMESPACE&gt;_&lt;MODULE&gt;_ERROR, * - The error domain is called <NAMESPACE>_<MODULE>_ERROR,
* for example %G_SPAWN_ERROR or %G_THREAD_ERROR: * for example %G_SPAWN_ERROR or %G_THREAD_ERROR:
* |[<!-- language="C" --> * |[<!-- language="C" -->
* #define G_SPAWN_ERROR g_spawn_error_quark () * #define G_SPAWN_ERROR g_spawn_error_quark ()
@ -256,20 +256,20 @@
* ]| * ]|
* *
* - The quark function for the error domain is called * - The quark function for the error domain is called
* &lt;namespace&gt;_&lt;module&gt;_error_quark, * <namespace>_<module>_error_quark,
* for example g_spawn_error_quark() or g_thread_error_quark(). * for example g_spawn_error_quark() or g_thread_error_quark().
* *
* - The error codes are in an enumeration called * - The error codes are in an enumeration called
* &lt;Namespace&gt;&lt;Module&gt;Error; * <Namespace><Module>Error;
* for example,#GThreadError or #GSpawnError. * for example, #GThreadError or #GSpawnError.
* *
* - Members of the error code enumeration are called * - Members of the error code enumeration are called
* &lt;NAMESPACE&gt;_&lt;MODULE&gt;_ERROR_&lt;CODE&gt;, * <NAMESPACE>_<MODULE>_ERROR_<CODE>,
* for example %G_SPAWN_ERROR_FORK or %G_THREAD_ERROR_AGAIN. * for example %G_SPAWN_ERROR_FORK or %G_THREAD_ERROR_AGAIN.
* *
* - If there's a "generic" or "unknown" error code for unrecoverable * - If there's a "generic" or "unknown" error code for unrecoverable
* errors it doesn't make sense to distinguish with specific codes, * errors it doesn't make sense to distinguish with specific codes,
* it should be called &lt;NAMESPACE&gt;_&lt;MODULE&gt;_ERROR_FAILED, * it should be called <NAMESPACE>_<MODULE>_ERROR_FAILED,
* for example %G_SPAWN_ERROR_FAILED. * for example %G_SPAWN_ERROR_FAILED.
* *
* Summary of rules for use of #GError: * Summary of rules for use of #GError:

4
glib/ggettext.c
View File

@ -473,8 +473,8 @@ g_dngettext (const gchar *domain,
* easy-to-use form. * easy-to-use form.
* *
* In order to use these macros in an application, you must include * In order to use these macros in an application, you must include
* `&lt;glib/gi18n.h&gt;`. For use in a library, you must include * `<glib/gi18n.h>`. For use in a library, you must include
* `&lt;glib/gi18n-lib.h&gt;` * `<glib/gi18n-lib.h>`
* after defining the %GETTEXT_PACKAGE macro suitably for your library: * after defining the %GETTEXT_PACKAGE macro suitably for your library:
* |[<!-- language="C" --> * |[<!-- language="C" -->
* #define GETTEXT_PACKAGE "gtk20" * #define GETTEXT_PACKAGE "gtk20"

6
glib/ghook.c
View File

@ -91,7 +91,7 @@
* *
* The position of the first bit which is not reserved for internal * The position of the first bit which is not reserved for internal
* use be the #GHook implementation, i.e. * use be the #GHook implementation, i.e.
* `1 &lt;&lt; G_HOOK_FLAG_USER_SHIFT` is the first * `1 << G_HOOK_FLAG_USER_SHIFT` is the first
* bit which can be used for application-defined flags. * bit which can be used for application-defined flags.
*/ */
@ -973,7 +973,7 @@ g_hook_find_func_data (GHookList *hook_list,
* Defines the type of function used to compare #GHook elements in * Defines the type of function used to compare #GHook elements in
* g_hook_insert_sorted(). * g_hook_insert_sorted().
* *
* Returns: a value &lt;= 0 if @new_hook should be before @sibling * Returns: a value <= 0 if @new_hook should be before @sibling
*/ */
/** /**
@ -1035,7 +1035,7 @@ g_hook_insert_sorted (GHookList *hook_list,
* Compares the ids of two #GHook elements, returning a negative value * Compares the ids of two #GHook elements, returning a negative value
* if the second id is greater than the first. * if the second id is greater than the first.
* *
* Returns: a value &lt;= 0 if the id of @sibling is >= the id of @new_hook * Returns: a value <= 0 if the id of @sibling is >= the id of @new_hook
*/ */
gint gint
g_hook_compare_ids (GHook *new_hook, g_hook_compare_ids (GHook *new_hook,

4
glib/glist.c
View File

@ -1195,7 +1195,7 @@ g_list_sort_real (GList *list,
* value comes before the second, 0 if they are equal, or a positive * value comes before the second, 0 if they are equal, or a positive
* integer if the first value comes after the second. * integer if the first value comes after the second.
* *
* Returns: negative value if @a &lt; @b; zero if @a = @b; positive * Returns: negative value if @a < @b; zero if @a = @b; positive
* value if @a > @b * value if @a > @b
*/ */
GList * GList *
@ -1227,7 +1227,7 @@ g_list_sort (GList *list,
* value comes before the second, 0 if they are equal, or a positive * value comes before the second, 0 if they are equal, or a positive
* integer if the first value comes after the second. * integer if the first value comes after the second.
* *
* Returns: negative value if @a &lt; @b; zero if @a = @b; positive * Returns: negative value if @a < @b; zero if @a = @b; positive
* value if @a > @b * value if @a > @b
*/ */
GList * GList *

10
glib/gmarkup.c
View File

@ -77,7 +77,7 @@
* *
* - Attributes * - Attributes
* *
* - 5 standard entities: &amp;amp; &amp;lt; &amp;gt; &amp;quot; &amp;apos; * - 5 standard entities: &amp; &lt; &gt; &quot; &apos;
* *
* - Character references * - Character references
* *
@ -631,7 +631,7 @@ unescape_gstring_inplace (GMarkupParseContext *context,
normalize_attribute = FALSE; normalize_attribute = FALSE;
/* /*
* Meeks' theorum: unescaping can only shrink text. * Meeks' theorem: unescaping can only shrink text.
* for &lt; etc. this is obvious, for &#xffff; more * for &lt; etc. this is obvious, for &#xffff; more
* thought is required, but this is patently so. * thought is required, but this is patently so.
*/ */
@ -2215,7 +2215,7 @@ append_escaped_text (GString *str,
* of line endings and attribute values. * of line endings and attribute values.
* *
* Note also that this function will produce character references in * Note also that this function will produce character references in
* the range of &amp;#x1; ... &amp;#x1f; for all control sequences * the range of &#x1; ... &#x1f; for all control sequences
* except for tabstop, newline and carriage return. The character * except for tabstop, newline and carriage return. The character
* references in this range are not valid XML 1.0, but they are * references in this range are not valid XML 1.0, but they are
* valid XML 1.1 and will be accepted by the GMarkup parser. * valid XML 1.1 and will be accepted by the GMarkup parser.
@ -2417,9 +2417,9 @@ g_markup_vprintf_escaped (const gchar *format,
* To find the span of the first argument, we find the first position * To find the span of the first argument, we find the first position
* where the two arguments differ, which tells us that the first * where the two arguments differ, which tells us that the first
* argument formatted to "Susan & Fred". We then escape that * argument formatted to "Susan & Fred". We then escape that
* to "Susan &amp; Fred" and join up with the intermediate portions * to "Susan & Fred" and join up with the intermediate portions
* of the format string and the second argument to get * of the format string and the second argument to get
* "Susan &amp; Fred ate 5 apples". * "Susan & Fred ate 5 apples".
*/ */
/* Create the two modified format strings /* Create the two modified format strings

2
glib/grand.c
View File

@ -92,7 +92,7 @@
* *
* The g_rand*_range functions will return high quality equally * The g_rand*_range functions will return high quality equally
* distributed random numbers, whereas for example the * distributed random numbers, whereas for example the
* `(g_random_int()&percnt;max)` approach often * `(g_random_int()\%max)` approach often
* doesn't yield equally distributed numbers. * doesn't yield equally distributed numbers.
* *
* GLib changed the seeding algorithm for the pseudo-random number * GLib changed the seeding algorithm for the pseudo-random number

25
glib/gregex.c
View File

@ -1103,7 +1103,7 @@ get_matched_substring_number (const GMatchInfo *match_info,
* Retrieves the text matching the capturing parentheses named @name. * Retrieves the text matching the capturing parentheses named @name.
* *
* If @name is a valid sub pattern name but it didn't match anything * If @name is a valid sub pattern name but it didn't match anything
* (e.g. sub pattern "X", matching "b" against "(?P&lt;X&gt;a)?b") * (e.g. sub pattern "X", matching "b" against "(?P<X>a)?b")
* then an empty string is returned. * then an empty string is returned.
* *
* The string is fetched from the string passed to the match function, * The string is fetched from the string passed to the match function,
@ -1144,7 +1144,7 @@ g_match_info_fetch_named (const GMatchInfo *match_info,
* Retrieves the position in bytes of the capturing parentheses named @name. * Retrieves the position in bytes of the capturing parentheses named @name.
* *
* If @name is a valid sub pattern name but it didn't match anything * If @name is a valid sub pattern name but it didn't match anything
* (e.g. sub pattern "X", matching "b" against "(?P&lt;X&gt;a)?b") * (e.g. sub pattern "X", matching "b" against "(?P<X>a)?b")
* then @start_pos and @end_pos are set to -1 and %TRUE is returned. * then @start_pos and @end_pos are set to -1 and %TRUE is returned.
* *
* Returns: %TRUE if the position was fetched, %FALSE otherwise. * Returns: %TRUE if the position was fetched, %FALSE otherwise.
@ -1824,15 +1824,15 @@ g_regex_match_all (const GRegex *regex,
* Using the standard algorithm for regular expression matching only * Using the standard algorithm for regular expression matching only
* the longest match in the string is retrieved, it is not possible * the longest match in the string is retrieved, it is not possible
* to obtain all the available matches. For instance matching * to obtain all the available matches. For instance matching
* "&lt;a&gt; &lt;b&gt; &lt;c&gt;" against the pattern "&lt;.*&gt;" * "<a> <b> <c>" against the pattern "<.*>"
* you get "&lt;a&gt; &lt;b&gt; &lt;c&gt;". * you get "<a> <b> <c>".
* *
* This function uses a different algorithm (called DFA, i.e. deterministic * This function uses a different algorithm (called DFA, i.e. deterministic
* finite automaton), so it can retrieve all the possible matches, all * finite automaton), so it can retrieve all the possible matches, all
* starting at the same point in the string. For instance matching * starting at the same point in the string. For instance matching
* "&lt;a&gt; &lt;b&gt; &lt;c&gt;" against the pattern "&lt;.*&gt;" * "<a> <b> <c>" against the pattern "<.*>;"
* you would obtain three matches: "&lt;a&gt; &lt;b&gt; &lt;c&gt;", * you would obtain three matches: "<a> <b> <c>",
* "&lt;a&gt; &lt;b&gt;" and "&lt;a&gt;". * "<a> <b>" and "<a>".
* *
* The number of matched strings is retrieved using * The number of matched strings is retrieved using
* g_match_info_get_match_count(). To obtain the matched strings and * g_match_info_get_match_count(). To obtain the matched strings and
@ -2694,11 +2694,12 @@ interpolation_list_needs_match (GList *list)
* *
* Replaces all occurrences of the pattern in @regex with the * Replaces all occurrences of the pattern in @regex with the
* replacement text. Backreferences of the form '\number' or * replacement text. Backreferences of the form '\number' or
* '\g&lt;number&gt;' in the replacement text are interpolated by the * '\g<number>' in the replacement text are interpolated by the
* number-th captured subexpression of the match, '\g&lt;name&gt;' refers * number-th captured subexpression of the match, '\g<name>' refers
* to the captured subexpression with the given name. '\0' refers to the * to the captured subexpression with the given name. '\0' refers
* complete match, but '\0' followed by a number is the octal representation * to the complete match, but '\0' followed by a number is the octal
* of a character. To include a literal '\' in the replacement, write '\\'. * representation of a character. To include a literal '\' in the
* replacement, write '\\'.
* *
* There are also escapes that changes the case of the following text: * There are also escapes that changes the case of the following text:
* *

30
glib/gstrfuncs.c
View File

@ -67,21 +67,21 @@
* g_snprintf(), g_vprintf(), g_vfprintf(), g_vsprintf() and g_vsnprintf() * g_snprintf(), g_vprintf(), g_vfprintf(), g_vsprintf() and g_vsnprintf()
* are declared in the header `gprintf.h` which is not included in `glib.h` * are declared in the header `gprintf.h` which is not included in `glib.h`
* (otherwise using `glib.h` would drag in `stdio.h`), so you'll have to * (otherwise using `glib.h` would drag in `stdio.h`), so you'll have to
* explicitly include `&lt;glib/gprintf.h&gt;` in order to use the GLib * explicitly include `<glib/gprintf.h>` in order to use the GLib
* printf() functions. * printf() functions.
* *
* ## String precision pitfalls # {#string-precision} * ## String precision pitfalls # {#string-precision}
* *
* While you may use the printf() functions to format UTF-8 strings, * While you may use the printf() functions to format UTF-8 strings,
* notice that the precision of a &percnt;Ns parameter is interpreted * notice that the precision of a \%Ns parameter is interpreted
* as the number of bytes, not characters to print. On top of that, * as the number of bytes, not characters to print. On top of that,
* the GNU libc implementation of the printf() functions has the * the GNU libc implementation of the printf() functions has the
* "feature" that it checks that the string given for the &percnt;Ns * "feature" that it checks that the string given for the \%Ns
* parameter consists of a whole number of characters in the current * parameter consists of a whole number of characters in the current
* encoding. So, unless you are sure you are always going to be in an * encoding. So, unless you are sure you are always going to be in an
* UTF-8 locale or your know your text is restricted to ASCII, avoid * UTF-8 locale or your know your text is restricted to ASCII, avoid
* using &percnt;Ns. If your intention is to format strings for a * using \%Ns. If your intention is to format strings for a
* certain number of columns, then &percnt;Ns is not a correct solution * certain number of columns, then \%Ns is not a correct solution
* anyway, since it fails to take wide characters (see g_unichar_iswide()) * anyway, since it fails to take wide characters (see g_unichar_iswide())
* into account. * into account.
*/ */
@ -1234,7 +1234,7 @@ g_ascii_strtoll (const gchar *nptr,
* not all platforms support the strerror() function. * not all platforms support the strerror() function.
* *
* Returns: a UTF-8 string describing the error code. If the error code * Returns: a UTF-8 string describing the error code. If the error code
* is unknown, it returns "unknown error (&lt;code&gt;)". * is unknown, it returns "unknown error (<code>)".
*/ */
const gchar * const gchar *
g_strerror (gint errnum) g_strerror (gint errnum)
@ -1264,7 +1264,7 @@ g_strerror (gint errnum)
* the strsignal() function. * the strsignal() function.
* *
* Returns: a UTF-8 string describing the signal. If the signal is unknown, * Returns: a UTF-8 string describing the signal. If the signal is unknown,
* it returns "unknown signal (&lt;signum&gt;)". * it returns "unknown signal (<signum>)".
*/ */
const gchar * const gchar *
g_strsignal (gint signum) g_strsignal (gint signum)
@ -1734,8 +1734,8 @@ g_ascii_xdigit_value (gchar c)
* *
* Both @s1 and @s2 must be non-%NULL. * Both @s1 and @s2 must be non-%NULL.
* *
* Return value: 0 if the strings match, a negative value if @s1 &lt; @s2, * Return value: 0 if the strings match, a negative value if @s1 < @s2,
* or a positive value if @s1 &gt; @s2. * or a positive value if @s1 > @s2.
*/ */
gint gint
g_ascii_strcasecmp (const gchar *s1, g_ascii_strcasecmp (const gchar *s1,
@ -1775,8 +1775,8 @@ g_ascii_strcasecmp (const gchar *s1,
* function only on strings known to be in encodings where bytes * function only on strings known to be in encodings where bytes
* corresponding to ASCII letters always represent themselves. * corresponding to ASCII letters always represent themselves.
* *
* Return value: 0 if the strings match, a negative value if @s1 &lt; @s2, * Return value: 0 if the strings match, a negative value if @s1 < @s2,
* or a positive value if @s1 &gt; @s2. * or a positive value if @s1 > @s2.
*/ */
gint gint
g_ascii_strncasecmp (const gchar *s1, g_ascii_strncasecmp (const gchar *s1,
@ -1812,8 +1812,8 @@ g_ascii_strncasecmp (const gchar *s1,
* A case-insensitive string comparison, corresponding to the standard * A case-insensitive string comparison, corresponding to the standard
* strcasecmp() function on platforms which support it. * strcasecmp() function on platforms which support it.
* *
* Return value: 0 if the strings match, a negative value if @s1 &lt; @s2, * Return value: 0 if the strings match, a negative value if @s1 < @s2,
* or a positive value if @s1 &gt; @s2. * or a positive value if @s1 > @s2.
* *
* Deprecated:2.2: See g_strncasecmp() for a discussion of why this * Deprecated:2.2: See g_strncasecmp() for a discussion of why this
* function is deprecated and how to replace it. * function is deprecated and how to replace it.
@ -1860,8 +1860,8 @@ g_strcasecmp (const gchar *s1,
* to g_strcasecmp() except it only compares the first @n characters of * to g_strcasecmp() except it only compares the first @n characters of
* the strings. * the strings.
* *
* Return value: 0 if the strings match, a negative value if @s1 &lt; @s2, * Return value: 0 if the strings match, a negative value if @s1 < @s2,
* or a positive value if @s1 &gt; @s2. * or a positive value if @s1 > @s2.
* *
* Deprecated:2.2: The problem with g_strncasecmp() is that it does * Deprecated:2.2: The problem with g_strncasecmp() is that it does
* the comparison by calling toupper()/tolower(). These functions * the comparison by calling toupper()/tolower(). These functions

14
glib/gtestutils.c
View File

@ -393,7 +393,7 @@
* g_assert_cmpstr: * g_assert_cmpstr:
* @s1: a string (may be %NULL) * @s1: a string (may be %NULL)
* @cmp: The comparison operator to use. * @cmp: The comparison operator to use.
* One of ==, !=, &lt;, &gt;, &lt;=, &gt;=. * One of ==, !=, <, >, <=, >=.
* @s2: another string (may be %NULL) * @s2: another string (may be %NULL)
* *
* Debugging macro to compare two strings. If the comparison fails, * Debugging macro to compare two strings. If the comparison fails,
@ -417,7 +417,7 @@
* g_assert_cmpint: * g_assert_cmpint:
* @n1: an integer * @n1: an integer
* @cmp: The comparison operator to use. * @cmp: The comparison operator to use.
* One of ==, !=, &lt;, &gt;, &lt;=, &gt;=. * One of ==, !=, <, >, <=, >=.
* @n2: another integer * @n2: another integer
* *
* Debugging macro to compare two integers. * Debugging macro to compare two integers.
@ -434,7 +434,7 @@
* g_assert_cmpuint: * g_assert_cmpuint:
* @n1: an unsigned integer * @n1: an unsigned integer
* @cmp: The comparison operator to use. * @cmp: The comparison operator to use.
* One of ==, !=, &lt;, &gt;, &lt;=, &gt;=. * One of ==, !=, <, >, <=, >=.
* @n2: another unsigned integer * @n2: another unsigned integer
* *
* Debugging macro to compare two unsigned integers. * Debugging macro to compare two unsigned integers.
@ -451,7 +451,7 @@
* g_assert_cmphex: * g_assert_cmphex:
* @n1: an unsigned integer * @n1: an unsigned integer
* @cmp: The comparison operator to use. * @cmp: The comparison operator to use.
* One of ==, !=, &lt;, &gt;, &lt;=, &gt;=. * One of ==, !=, <, >, <=, >=.
* @n2: another unsigned integer * @n2: another unsigned integer
* *
* Debugging macro to compare to unsigned integers. * Debugging macro to compare to unsigned integers.
@ -466,7 +466,7 @@
* g_assert_cmpfloat: * g_assert_cmpfloat:
* @n1: an floating point number * @n1: an floating point number
* @cmp: The comparison operator to use. * @cmp: The comparison operator to use.
* One of ==, !=, &lt;, &gt;, &lt;=, &gt;=. * One of ==, !=, <, >, <=, >=.
* @n2: another floating point number * @n2: another floating point number
* *
* Debugging macro to compare two floating point numbers. * Debugging macro to compare two floating point numbers.
@ -503,8 +503,8 @@
* the correct #GError. * the correct #GError.
* *
* The effect of `g_assert_error (err, dom, c)` is * The effect of `g_assert_error (err, dom, c)` is
* the same as `g_assert_true (err != NULL &amp;&amp; err->domain * the same as `g_assert_true (err != NULL && err->domain
* == dom &amp;&amp; err->code == c)`. The advantage of this * == dom && err->code == c)`. The advantage of this
* macro is that it can produce a message that includes the incorrect * macro is that it can produce a message that includes the incorrect
* error message and code. * error message and code.
* *

4
glib/gunicollate.c
View File

@ -71,8 +71,8 @@ msc_strxfrm_wrapper (char *string1,
* compare the keys with strcmp() when sorting instead of sorting * compare the keys with strcmp() when sorting instead of sorting
* the original strings. * the original strings.
* *
* Return value: &lt; 0 if @str1 compares before @str2, * Return value: < 0 if @str1 compares before @str2,
* 0 if they compare equal, &gt; 0 if @str1 compares after @str2. * 0 if they compare equal, > 0 if @str1 compares after @str2.
**/ **/
gint gint
g_utf8_collate (const gchar *str1, g_utf8_collate (const gchar *str1,

16
glib/gvariant.c
View File

@ -2762,9 +2762,9 @@ g_variant_equal (gconstpointer one,
* If you only require an equality comparison, g_variant_equal() is more * If you only require an equality comparison, g_variant_equal() is more
* general. * general.
* *
* Returns: negative value if a &lt; b; * Returns: negative value if a < b;
* zero if a = b; * zero if a = b;
* positive value if a &gt; b. * positive value if a > b.
* *
* Since: 2.26 * Since: 2.26
**/ **/
@ -3672,17 +3672,17 @@ g_variant_builder_end (GVariantBuilder *builder)
* GVariantDict dict; * GVariantDict dict;
* guint32 count; * guint32 count;
* *
* g_variant_dict_init (&amp;dict, orig); * g_variant_dict_init (&dict, orig);
* if (!g_variant_dict_lookup (&amp;dict, "count", "u", &amp;count)) * if (!g_variant_dict_lookup (&dict, "count", "u", &count))
* { * {
* g_set_error (...); * g_set_error (...);
* g_variant_dict_clear (&amp;dict); * g_variant_dict_clear (&dict);
* return NULL; * return NULL;
* } * }
* *
* g_variant_dict_insert (&amp;dict, "count", "u", count + 1); * g_variant_dict_insert (&dict, "count", "u", count + 1);
* *
* return g_variant_dict_end (&amp;dict); * return g_variant_dict_end (&dict);
* } * }
* ]| * ]|
* *
@ -3699,7 +3699,7 @@ g_variant_builder_end (GVariantBuilder *builder)
* *
* dict = g_variant_dict_new (orig); * dict = g_variant_dict_new (orig);
* *
* if (g_variant_dict_lookup (dict, "count", "u", &amp;count)) * if (g_variant_dict_lookup (dict, "count", "u", &count))
* { * {
* g_variant_dict_insert (dict, "count", "u", count + 1); * g_variant_dict_insert (dict, "count", "u", count + 1);
* result = g_variant_dict_end (dict); * result = g_variant_dict_end (dict);

4
glib/gwin32.c
View File

@ -335,8 +335,8 @@ get_package_directory_from_module (const gchar *module_name)
* the package, typically the same identifier as used for * the package, typically the same identifier as used for
* `GETTEXT_PACKAGE` in software configured using GNU * `GETTEXT_PACKAGE` in software configured using GNU
* autotools. The function first looks in the Windows Registry for the * autotools. The function first looks in the Windows Registry for the
* value `&num;InstallationDirectory` in the key * value `#InstallationDirectory` in the key
* `&num;HKLM\Software\@package`, and if that value * `#HKLM\Software\@package`, and if that value
* exists and is a string, returns that. * exists and is a string, returns that.
* *
* It is strongly recommended that packagers of GLib-using libraries * It is strongly recommended that packagers of GLib-using libraries

2
gobject/gvaluearray.c
View File

@ -257,7 +257,7 @@ g_value_array_append (GValueArray *value_array,
/** /**
* g_value_array_insert: * g_value_array_insert:
* @value_array: #GValueArray to add an element to * @value_array: #GValueArray to add an element to
* @index_: insertion position, must be &lt;= value_array-&gt;n_values * @index_: insertion position, must be <= value_array-&gt;n_values
* @value: (allow-none): #GValue to copy into #GValueArray, or %NULL * @value: (allow-none): #GValue to copy into #GValueArray, or %NULL
* *
* Insert a copy of @value at specified position into @value_array. If @value * Insert a copy of @value at specified position into @value_array. If @value