From 2411b76c5e63aa2ef7fcc131e6f5c5e73c998615 Mon Sep 17 00:00:00 2001 From: Philip Withnall Date: Thu, 16 Mar 2017 13:50:19 +0000 Subject: [PATCH] docs: Fix some DocBook usage in a few gtk-doc comments and tags. Replace them with Markdown. Signed-off-by: Philip Withnall --- gio/gappinfo.h | 3 +-- gio/gdbusconnection.h | 2 +- gio/gioenums.h | 2 +- glib/deprecated/gcache.c | 4 ++-- glib/gunicode.h | 8 +++----- 5 files changed, 8 insertions(+), 11 deletions(-) diff --git a/gio/gappinfo.h b/gio/gappinfo.h index 8b417a79e..726af62e1 100644 --- a/gio/gappinfo.h +++ b/gio/gappinfo.h @@ -66,8 +66,7 @@ typedef struct _GAppLaunchContextPrivate GAppLaunchContextPrivate; * @supports_files: Indicates whether the application specified accepts filename arguments. * @launch_uris: Launches an application with a list of URIs. * @should_show: Returns whether an application should be shown (e.g. when getting a list of installed applications). - * - * FreeDesktop.Org Startup Notification Specification. + * [FreeDesktop.Org Startup Notification Specification](http://standards.freedesktop.org/startup-notification-spec/startup-notification-latest.txt). * @set_as_default_for_type: Sets an application as default for a given content type. * @set_as_default_for_extension: Sets an application as default for a given file extension. * @add_supports_type: Adds to the #GAppInfo information about supported file types. diff --git a/gio/gdbusconnection.h b/gio/gdbusconnection.h index 0e61885b8..7aa125689 100644 --- a/gio/gdbusconnection.h +++ b/gio/gdbusconnection.h @@ -648,7 +648,7 @@ void g_dbus_connection_signal_unsubscribe (GDBusConnection * If the returned #GDBusMessage is different from @message and cannot * be sent on @connection (it could use features, such as file * descriptors, not compatible with @connection), then a warning is - * logged to standard error. Applications can + * logged to standard error. Applications can * check this ahead of time using g_dbus_message_to_blob() passing a * #GDBusCapabilityFlags value obtained from @connection. * diff --git a/gio/gioenums.h b/gio/gioenums.h index fd090af5f..ee17370e7 100644 --- a/gio/gioenums.h +++ b/gio/gioenums.h @@ -989,7 +989,7 @@ typedef enum * @G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START: If the proxy is for a well-known name, * do not ask the bus to launch an owner during proxy initialization or a method call. * This flag is only meaningful in proxies for well-known names. - * @G_DBUS_PROXY_FLAGS_GET_INVALIDATED_PROPERTIES: If set, the property value for any invalidated property will be (asynchronously) retrieved upon receiving the PropertiesChanged D-Bus signal and the property will not cause emission of the #GDBusProxy::g-properties-changed signal. When the value is received the #GDBusProxy::g-properties-changed signal is emitted for the property along with the retrieved value. Since 2.32. + * @G_DBUS_PROXY_FLAGS_GET_INVALIDATED_PROPERTIES: If set, the property value for any __invalidated property__ will be (asynchronously) retrieved upon receiving the [`PropertiesChanged`](http://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-properties) D-Bus signal and the property will not cause emission of the #GDBusProxy::g-properties-changed signal. When the value is received the #GDBusProxy::g-properties-changed signal is emitted for the property along with the retrieved value. Since 2.32. * @G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START_AT_CONSTRUCTION: If the proxy is for a well-known name, * do not ask the bus to launch an owner during proxy initialization, but allow it to be * autostarted by a method call. This flag is only meaningful in proxies for well-known names, diff --git a/glib/deprecated/gcache.c b/glib/deprecated/gcache.c index 878c922f7..d91bdfcb5 100644 --- a/glib/deprecated/gcache.c +++ b/glib/deprecated/gcache.c @@ -154,12 +154,12 @@ g_cache_node_destroy (GCacheNode *node) /** * GCacheDupFunc: - * @value: the #GCache key to destroy (not a + * @value: the #GCache key to destroy (__not__ a * #GCache value as it seems) * * Specifies the type of the @key_dup_func function passed to * g_cache_new(). The function is passed a key - * (not a value as the prototype implies) and + * (__not__ a value as the prototype implies) and * should return a duplicate of the key. * * Returns: a copy of the #GCache key diff --git a/glib/gunicode.h b/glib/gunicode.h index 42ff5409d..e7cc04e6d 100644 --- a/glib/gunicode.h +++ b/glib/gunicode.h @@ -111,7 +111,7 @@ typedef guint16 gunichar2; * * These are the possible character classifications from the * Unicode specification. - * See Unicode Character Database. + * See [Unicode Character Database](http://www.unicode.org/reports/tr44/#General_Category_Values). */ typedef enum { @@ -209,7 +209,7 @@ typedef enum * Since new unicode versions may add new types here, applications should be ready * to handle unknown values. They may be regarded as %G_UNICODE_BREAK_UNKNOWN. * - * See http://www.unicode.org/unicode/reports/tr14/. + * See [Unicode Line Breaking Algorithm](http://www.unicode.org/unicode/reports/tr14/). */ typedef enum { @@ -419,9 +419,7 @@ typedef enum * * Note that new types may be added in the future. Applications * should be ready to handle unknown values. - * See Unicode Standard Annex - * #24: Script names. + * See [Unicode Standard Annex #24: Script names](http://www.unicode.org/reports/tr24/). */ typedef enum { /* ISO 15924 code */