Docs: Drop entities, switch away from sgml mode

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

View File

@@ -41,7 +41,7 @@
* (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
* 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
* only work if a set of suitable GIO extensions (such as gvfs 2.26
* compiled with FUSE support), is available and operational; if this

View File

@@ -60,7 +60,7 @@
*
* 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
* 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);

View File

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

View File

@@ -58,7 +58,7 @@
* #GDesktopAppInfo is an implementation of #GAppInfo based on
* 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
* file when using it.
*/

View File

@@ -321,7 +321,7 @@ escape_byte_string (const char *str)
* Converts a #GFileAttributeValue to a string for display.
* 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.
*/
char *

View File

@@ -32,7 +32,7 @@
* #GFileDescriptorBased is implemented by streams (implementations of
* #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
* file when using it.
*

View File

@@ -197,7 +197,7 @@ g_icon_to_string_tokenized (GIcon *icon, GString *s)
* (such as `/path/to/my icon.png`) without escaping
* 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()
* (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
* simply the name (such as `network-server`).

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,
* @format_string must make a complete copy of the data (since the
* #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
* type

View File

@@ -28,7 +28,7 @@
* @short_description: System networking includes
* @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
* taking care of certain portability issues for you.
*

View File

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

View File

@@ -86,9 +86,9 @@
* Similar to GConf, the default values in GSettings schemas can be
* localized, but the localized values are stored in gettext catalogs
* 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
* the &lt;key&gt; element.
* the <key> element.
*
* GSettings uses schemas in a compact binary form that is created
* by the [glib-compile-schemas][glib-compile-schemas]
@@ -101,7 +101,7 @@
* files to have the extension `.gschema.xml`.
*
* 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,
* 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
@@ -110,8 +110,8 @@
* StudlyCaps, e.g. "org.gnome.font-rendering".
*
* In addition to #GVariant types, keys can have types that have
* enumerated types. These can be described by a &lt;choice&gt;,
* &lt;enum&gt; or &lt;flags&gt; element, as seen in the
* enumerated types. These can be described by a <choice>,
* <enum> or <flags> element, as seen in the
* [example][schema-enumerated]. The underlying type of such a key
* 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
@@ -2178,7 +2178,7 @@ g_settings_is_writable (GSettings *settings,
* @settings.
*
* 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
*

View File

@@ -68,7 +68,7 @@
* SECTION:gsocket
* @short_description: Low-level socket object
* @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
* 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,
* 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
* standard/portable socket options. For unusual socket protocols or
* 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,
* 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
* standard/portable socket options. For unusual socket protocols or
* platform-dependent options, you may need to include additional

View File

@@ -39,7 +39,7 @@
* It contains functions to do some of the UNIX socket specific
* 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`
* pkg-config file when using it.
*

View File

@@ -26,7 +26,7 @@
* the %G_SOCKET_ADDRESS_UNIX family by using g_socket_send_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
* file when using it.
*/

View File

@@ -29,7 +29,7 @@
* stream-oriented UNIX sockets, see g_unix_connection_send_fd() and
* 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
* file when using it.
*/

View File

@@ -51,7 +51,7 @@
* asynchronous I/O. If it refers to a regular file, it will fall back
* 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
* file when using it.
*/

View File

@@ -79,7 +79,7 @@ static const char *_resolve_dev_root (void);
*
* 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
* file when using it.
*/

View File

@@ -51,7 +51,7 @@
* asynchronous I/O. If it refers to a regular file, it will fall back
* 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
* when using it.
*/

View File

@@ -44,7 +44,7 @@
* errors. You can use g_unix_socket_address_abstract_names_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
* when using it.
*/

View File

@@ -44,7 +44,7 @@
* #GWin32InputStream implements #GInputStream for reading from a
* 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
* when using it.
*/

View File

@@ -45,7 +45,7 @@
* #GWin32OutputStream implements #GOutputStream for writing to a
* 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
* when using it.
*/