From cb588d45320c5a6b767d299ebd85306d45e1773c Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Wed, 5 Feb 2014 21:23:28 -0500 Subject: [PATCH] Convert external links to markdown syntax --- gio/gappinfo.c | 5 ++--- gio/gapplication.c | 2 +- gio/gapplicationcommandline.c | 9 ++++++--- gio/gcontenttype.c | 10 +++++++--- gio/gdbusinterfaceskeleton.c | 10 +++++----- gio/gdbusintrospection.c | 2 +- gio/gdbusobjectmanager.c | 4 ++-- gio/gdbusobjectmanagerclient.c | 4 ++-- gio/gdbusobjectmanagerserver.c | 4 ++-- gio/gdbusproxy.c | 7 ++++--- gio/gdesktopappinfo.c | 15 ++++++++------- gio/gfile.c | 3 ++- gio/gfiledescriptorbased.c | 2 +- gio/gmount.c | 6 ++++-- gio/gsettings.c | 3 ++- gio/gtestdbus.c | 3 ++- gio/gunixconnection.c | 2 +- gio/gunixfdlist.c | 2 +- gio/gunixfdmessage.c | 2 +- gio/gunixinputstream.c | 2 +- gio/gunixmounts.c | 2 +- gio/gunixoutputstream.c | 2 +- gio/gunixsocketaddress.c | 2 +- gio/gwin32inputstream.c | 2 +- gio/gwin32outputstream.c | 2 +- glib/docs.c | 2 +- glib/gbase64.c | 8 +++++--- glib/gbookmarkfile.c | 10 +++++----- glib/ghash.c | 3 ++- glib/ghmac.c | 3 ++- glib/ghostutils.c | 6 +++--- glib/gkeyfile.c | 24 +++++++++++------------ glib/gmarkup.c | 8 ++++---- glib/gmessages.c | 8 ++++---- glib/grand.c | 5 ++--- glib/gregex.c | 9 +++++---- glib/gslice.c | 6 ++++-- glib/gtimer.c | 10 +++++----- glib/gtimezone.c | 19 +++++++++---------- glib/gunidecomp.c | 11 +++++++---- glib/guniprop.c | 16 +++++++++------- glib/gurifuncs.c | 5 +++-- glib/gutils.c | 43 +++++++++++++++++++++--------------------- glib/gvarianttype.c | 10 +++++----- gobject/gclosure.c | 4 ++-- 45 files changed, 170 insertions(+), 147 deletions(-) diff --git a/gio/gappinfo.c b/gio/gappinfo.c index 266b22c..eee58f5 100644 --- a/gio/gappinfo.c +++ b/gio/gappinfo.c @@ -981,9 +981,8 @@ g_app_launch_context_get_display (GAppLaunchContext *context, * Initiates startup notification for the application and returns the * `DESKTOP_STARTUP_ID` for the launched operation, if supported. * - * Startup notification IDs are defined in the - * FreeDesktop.Org Startup Notifications standard. + * Startup notification IDs are defined in the + * [FreeDesktop.Org Startup Notifications standard](http://standards.freedesktop.org/startup-notification-spec/startup-notification-latest.txt"). * * Returns: a startup notification ID for the application, or %NULL if * not supported. diff --git a/gio/gapplication.c b/gio/gapplication.c index 6a42399..b8bc914 100644 --- a/gio/gapplication.c +++ b/gio/gapplication.c @@ -89,7 +89,7 @@ * * If used, the expected form of an application identifier is very close * to that of of a - * DBus bus name. + * [DBus bus name](http://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-names-interface). * Examples include: "com.example.MyApp", "org.example.internal-apps.Calculator". * For details on valid application identifiers, see g_application_id_is_valid(). * diff --git a/gio/gapplicationcommandline.c b/gio/gapplicationcommandline.c index d804322..258baa7 100644 --- a/gio/gapplicationcommandline.c +++ b/gio/gapplicationcommandline.c @@ -102,7 +102,8 @@ * return 0; * } * ]| - * The complete example can be found here: gapplication-example-cmdline.c + * The complete example can be found here: + * [gapplication-example-cmdline.c](https://git.gnome.org/browse/glib/tree/gio/tests/gapplication-example-cmdline.c) * * In more complicated cases, the handling of the comandline can be * split between the launcher and the primary instance. @@ -152,7 +153,8 @@ * options are passed to the #GApplication::command-line handler * which runs in the primary instance. * - * The complete example can be found here: gapplication-example-cmdline2.c + * The complete example can be found here: + * [gapplication-example-cmdline2.c](https://git.gnome.org/browse/glib/tree/gio/tests/gapplication-example-cmdline2.c) * * If handling the commandline requires a lot of work, it may * be better to defer it. @@ -193,7 +195,8 @@ * later (in this example, in an idle). Note that it is necessary to * hold the application until you are done with the commandline. * - * The complete example can be found here: gapplication-example-cmdline3.c + * The complete example can be found here: + * [gapplication-example-cmdline3.c](https://git.gnome.org/browse/glib/tree/gio/tests/gapplication-example-cmdline3.c) */ /** diff --git a/gio/gcontenttype.c b/gio/gcontenttype.c index a3b6dde..0ac90cb 100644 --- a/gio/gcontenttype.c +++ b/gio/gcontenttype.c @@ -40,7 +40,9 @@ * @include: gio/gio.h * * A content type is a platform specific string that defines the type - * of a file. On UNIX it is a mime type like "text/plain" or "image/png". + * of a file. On UNIX it is a + * [mime type](http://www.wikipedia.org/wiki/Internet_media_type) + * like "text/plain" or "image/png". * On Win32 it is an extension string like ".doc", ".txt" or a perceived * string like "audio". Such strings can be looked up in the registry at * HKEY_CLASSES_ROOT. @@ -486,7 +488,8 @@ g_content_type_get_symbolic_icon (const gchar *type) * * Gets the generic icon name for a content type. * - * See the shared-mime-info + * See the + * [shared-mime-info](http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec) * specification for more on the generic icon name. * * Returns: (allow-none): the registered generic icon name for the given @type, @@ -1374,7 +1377,8 @@ match_match (TreeMatch *match, * * The types returned all have the form x-content/foo, e.g. * x-content/audio-cdda (for audio CDs) or x-content/image-dcf - * (for a camera memory card). See the shared-mime-info + * (for a camera memory card). See the + * [shared-mime-info](http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec) * specification for more on x-content types. * * This function is useful in the implementation of diff --git a/gio/gdbusinterfaceskeleton.c b/gio/gdbusinterfaceskeleton.c index 32d9c95..edf9265 100644 --- a/gio/gdbusinterfaceskeleton.c +++ b/gio/gdbusinterfaceskeleton.c @@ -208,11 +208,11 @@ g_dbus_interface_skeleton_class_init (GDBusInterfaceSkeletonClass *klass) * * Note that this signal is emitted in a thread dedicated to * handling the method call so handlers are allowed to perform - * blocking IO. This means that it is appropriate to call - * e.g. polkit_authority_check_authorization_sync() - * with the POLKIT_CHECK_AUTHORIZATION_FLAGS_ALLOW_USER_INTERACTION flag set. + * blocking IO. This means that it is appropriate to call e.g. + * [polkit_authority_check_authorization_sync()](http://hal.freedesktop.org/docs/polkit/PolkitAuthority.html#polkit-authority-check-authorization-sync) + * with the + * [POLKIT_CHECK_AUTHORIZATION_FLAGS_ALLOW_USER_INTERACTION](http://hal.freedesktop.org/docs/polkit/PolkitAuthority.html#POLKIT-CHECK-AUTHORIZATION-FLAGS-ALLOW-USER-INTERACTION:CAPS) + * flag set. * * If %FALSE is returned then no further handlers are run and the * signal handler must take a reference to @invocation and finish diff --git a/gio/gdbusintrospection.c b/gio/gdbusintrospection.c index 9a34f90..44bb7ae 100644 --- a/gio/gdbusintrospection.c +++ b/gio/gdbusintrospection.c @@ -38,7 +38,7 @@ * used when registering objects with g_dbus_connection_register_object(). * * The format of D-Bus introspection XML is specified in the - * D-Bus specification. + * [D-Bus specification](http://dbus.freedesktop.org/doc/dbus-specification.html#introspection-format) */ /* ---------------------------------------------------------------------------------------------------- */ diff --git a/gio/gdbusobjectmanager.c b/gio/gdbusobjectmanager.c index e524728..25081b1 100644 --- a/gio/gdbusobjectmanager.c +++ b/gio/gdbusobjectmanager.c @@ -33,8 +33,8 @@ * @include: gio/gio.h * * The #GDBusObjectManager type is the base type for service- and - * client-side implementations of the standardized org.freedesktop.DBus.ObjectManager + * client-side implementations of the standardized + * [org.freedesktop.DBus.ObjectManager](http://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-objectmanager) * interface. * * See #GDBusObjectManagerClient for the client-side implementation diff --git a/gio/gdbusobjectmanagerclient.c b/gio/gdbusobjectmanagerclient.c index f114ce4..fb8c3d0 100644 --- a/gio/gdbusobjectmanagerclient.c +++ b/gio/gdbusobjectmanagerclient.c @@ -45,8 +45,8 @@ * * #GDBusObjectManagerClient is used to create, monitor and delete object * proxies for remote objects exported by a #GDBusObjectManagerServer (or any - * code implementing the org.freedesktop.DBus.ObjectManager + * code implementing the + * [org.freedesktop.DBus.ObjectManager](http://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-objectmanager) * interface). * * Once an instance of this type has been created, you can connect to diff --git a/gio/gdbusobjectmanagerserver.c b/gio/gdbusobjectmanagerserver.c index a5dff21..bb6f8c2 100644 --- a/gio/gdbusobjectmanagerserver.c +++ b/gio/gdbusobjectmanagerserver.c @@ -38,8 +38,8 @@ * @include: gio/gio.h * * #GDBusObjectManagerServer is used to export #GDBusObject instances using - * the standardized org.freedesktop.DBus.ObjectManager + * the standardized + * [org.freedesktop.DBus.ObjectManager](http://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-objectmanager) * interface. For example, remote D-Bus clients can get all objects * and properties in a single call. Additionally, any change in the * object hierarchy is broadcast using signals. This means that D-Bus diff --git a/gio/gdbusproxy.c b/gio/gdbusproxy.c index a4b71c8..878561f 100644 --- a/gio/gdbusproxy.c +++ b/gio/gdbusproxy.c @@ -372,9 +372,10 @@ g_dbus_proxy_class_init (GDBusProxyClass *klass) * * - Properties received via the initial GetAll() call * or via the ::PropertiesChanged signal (on the - * org.freedesktop.DBus.Properties interface) or - * set using g_dbus_proxy_set_cached_property() with a type signature - * mismatch are ignored and a warning is logged via g_warning(). + * [org.freedesktop.DBus.Properties](http://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-properties) + * interface) or set using g_dbus_proxy_set_cached_property() + * with a type signature mismatch are ignored and a warning is + * logged via g_warning(). * * Note that these checks are never done on methods, signals and * properties that are not referenced in the given diff --git a/gio/gdesktopappinfo.c b/gio/gdesktopappinfo.c index af14815..011d737 100644 --- a/gio/gdesktopappinfo.c +++ b/gio/gdesktopappinfo.c @@ -58,7 +58,7 @@ * #GDesktopAppInfo is an implementation of #GAppInfo based on * desktop files. * - * Note that `` 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. */ @@ -1310,8 +1310,8 @@ g_desktop_app_info_new_from_filename (const char *filename) * data directories (i.e. the directories specified in the `XDG_DATA_HOME` * and `XDG_DATA_DIRS` environment variables). GIO also supports the * prefix-to-subdirectory mapping that is described in the - * Menu - * Spec (i.e. a desktop id of kde-foo.desktop will match + * [Menu Spec](http://standards.freedesktop.org/menu-spec/latest/) + * (i.e. a desktop id of kde-foo.desktop will match * `/usr/share/applications/kde/foo.desktop`). * * Returns: a new #GDesktopAppInfo, or %NULL if no desktop file with that id @@ -2476,8 +2476,9 @@ g_desktop_app_info_launch_uris_as_manager (GDesktopAppInfo *appinfo, * OnlyShowIn and NotShowIn * desktop entry fields. * - * The Desktop - * Menu specification recognizes the following: + * The + * [Desktop Menu specification](http://standards.freedesktop.org/menu-spec/latest/) + * recognizes the following: * * GNOME * KDE @@ -3126,8 +3127,8 @@ g_desktop_app_info_delete (GAppInfo *appinfo) * Creates a new #GAppInfo from the given information. * * Note that for @commandline, the quoting rules of the Exec key of the - * freedesktop.org Desktop - * Entry Specification are applied. For example, if the @commandline contains + * [freedesktop.org Desktop Entry Specification](http://freedesktop.org/Standards/desktop-entry-spec) + * are applied. For example, if the @commandline contains * percent-encoded URIs, the percent-character must be doubled in order to prevent it from * being swallowed by Exec key unquoting. See the specification for exact quoting rules. * diff --git a/gio/gfile.c b/gio/gfile.c index c24bf38..1114530 100644 --- a/gio/gfile.c +++ b/gio/gfile.c @@ -142,7 +142,8 @@ * short. Entity tags are somewhat like a more abstract version of the * traditional mtime, and can be used to quickly determine if the file * has been modified from the version on the file system. See the - * HTTP 1.1 specification + * HTTP 1.1 + * [specification](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html) * for HTTP Etag headers, which are a very similar concept. * **/ diff --git a/gio/gfiledescriptorbased.c b/gio/gfiledescriptorbased.c index a0ae222..130d107 100644 --- a/gio/gfiledescriptorbased.c +++ b/gio/gfiledescriptorbased.c @@ -32,7 +32,7 @@ * #GFileDescriptorBased is implemented by streams (implementations of * #GInputStream or #GOutputStream) that are based on file descriptors. * - * Note that `` 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. * diff --git a/gio/gmount.c b/gio/gmount.c index 6b17291..f11c650 100644 --- a/gio/gmount.c +++ b/gio/gmount.c @@ -767,7 +767,8 @@ g_mount_remount_finish (GMount *mount, * Tries to guess the type of content stored on @mount. Returns one or * more textual identifiers of well-known content types (typically * prefixed with "x-content/"), e.g. x-content/image-dcf for camera - * memory cards. See the shared-mime-info + * memory cards. See the + * [shared-mime-info](http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec) * specification for more on x-content types. * * This is an asynchronous operation (see @@ -854,7 +855,8 @@ g_mount_guess_content_type_finish (GMount *mount, * Tries to guess the type of content stored on @mount. Returns one or * more textual identifiers of well-known content types (typically * prefixed with "x-content/"), e.g. x-content/image-dcf for camera - * memory cards. See the shared-mime-info + * memory cards. See the + * [shared-mime-info](http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec) * specification for more on x-content types. * * This is an synchronous operation and as such may block doing IO; diff --git a/gio/gsettings.c b/gio/gsettings.c index 28a9ebb..594ee94 100644 --- a/gio/gsettings.c +++ b/gio/gsettings.c @@ -95,7 +95,8 @@ * by the glib-compile-schemas * utility. The input is a schema description in an XML format. * - * A DTD for the gschema XML format can be found here: gschema.dtd + * A DTD for the gschema XML format can be found here: + * [gschema.dtd](https://git.gnome.org/browse/glib/tree/gio/gschema.dtd) * * The glib-compile-schemas * tool expects schema files to have the extension `.gschema.xml`. diff --git a/gio/gtestdbus.c b/gio/gtestdbus.c index f7cc0a6..17a9496 100644 --- a/gio/gtestdbus.c +++ b/gio/gtestdbus.c @@ -361,7 +361,8 @@ _g_test_watcher_remove_pid (GPid pid) * you can proceed to set up a GTest fixture using the #GTestDBus scaffolding. * * An example of a test fixture for D-Bus services can be found - * here: gdbus-test-fixture.c + * here: + * [gdbus-test-fixture.c](https://git.gnome.org/browse/glib/tree/gio/tests/gdbus-test-fixture.c) * * Note that these examples only deal with isolating the D-Bus aspect of your * service. To successfully run isolated unit tests on your service you may need diff --git a/gio/gunixconnection.c b/gio/gunixconnection.c index b5da60a..f2269c7 100644 --- a/gio/gunixconnection.c +++ b/gio/gunixconnection.c @@ -39,7 +39,7 @@ * It contains functions to do some of the UNIX socket specific * functionality like passing file descriptors. * - * Note that `` 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. * diff --git a/gio/gunixfdlist.c b/gio/gunixfdlist.c index 5808e40..b42362c 100644 --- a/gio/gunixfdlist.c +++ b/gio/gunixfdlist.c @@ -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 `` 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. */ diff --git a/gio/gunixfdmessage.c b/gio/gunixfdmessage.c index 12e62c5..3b9e73a 100644 --- a/gio/gunixfdmessage.c +++ b/gio/gunixfdmessage.c @@ -29,7 +29,7 @@ * stream-oriented UNIX sockets, see g_unix_connection_send_fd() and * g_unix_connection_receive_fd(). * - * Note that `` 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. */ diff --git a/gio/gunixinputstream.c b/gio/gunixinputstream.c index 1d7d88d..388cc80 100644 --- a/gio/gunixinputstream.c +++ b/gio/gunixinputstream.c @@ -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 `` 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. */ diff --git a/gio/gunixmounts.c b/gio/gunixmounts.c index 4999354..63dbe23 100644 --- a/gio/gunixmounts.c +++ b/gio/gunixmounts.c @@ -79,7 +79,7 @@ static const char *_resolve_dev_root (void); * * Routines for managing mounted UNIX mount points and paths. * - * Note that `` 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. */ diff --git a/gio/gunixoutputstream.c b/gio/gunixoutputstream.c index 353be07..b748a95 100644 --- a/gio/gunixoutputstream.c +++ b/gio/gunixoutputstream.c @@ -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 `` 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. */ diff --git a/gio/gunixsocketaddress.c b/gio/gunixsocketaddress.c index 6b46ed0..3e83fd3 100644 --- a/gio/gunixsocketaddress.c +++ b/gio/gunixsocketaddress.c @@ -44,7 +44,7 @@ * errors. You can use g_unix_socket_address_abstract_names_supported() * to see if abstract names are supported. * - * Note that `` 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. */ diff --git a/gio/gwin32inputstream.c b/gio/gwin32inputstream.c index 685ecb0..bf142d6 100644 --- a/gio/gwin32inputstream.c +++ b/gio/gwin32inputstream.c @@ -44,7 +44,7 @@ * #GWin32InputStream implements #GInputStream for reading from a * Windows file handle. * - * Note that `` 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. */ diff --git a/gio/gwin32outputstream.c b/gio/gwin32outputstream.c index 13476c0..5040ac4 100644 --- a/gio/gwin32outputstream.c +++ b/gio/gwin32outputstream.c @@ -45,7 +45,7 @@ * #GWin32OutputStream implements #GOutputStream for writing to a * Windows file handle. * - * Note that `` 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. */ diff --git a/glib/docs.c b/glib/docs.c index ea4dc2d..fdc9216 100644 --- a/glib/docs.c +++ b/glib/docs.c @@ -1428,7 +1428,7 @@ * sign, mantissa and exponent of IEEE floats and doubles. These unions are * defined as appropriate for a given platform. IEEE floats and doubles are * supported (used for storage) by at least Intel, PPC and Sparc. See - * IEEE 754-2008 + * [IEEE 754-2008](http://en.wikipedia.org/wiki/IEEE_float) * for more information about IEEE number formats. */ diff --git a/glib/gbase64.c b/glib/gbase64.c index 7c7ab7b..7a90f04 100644 --- a/glib/gbase64.c +++ b/glib/gbase64.c @@ -37,9 +37,11 @@ * * Base64 is an encoding that allows a sequence of arbitrary bytes to be * encoded as a sequence of printable ASCII characters. For the definition - * of Base64, see RFC - * 1421 or RFC - * 2045. Base64 is most commonly used as a MIME transfer encoding + * of Base64, see + * [RFC 1421](http://www.ietf.org/rfc/rfc1421.txt) + * or + * [RFC 2045](http://www.ietf.org/rfc/rfc2045.txt). + * Base64 is most commonly used as a MIME transfer encoding * for email. * * GLib supports incremental encoding using g_base64_encode_step() and diff --git a/glib/gbookmarkfile.c b/glib/gbookmarkfile.c index 68069fc..bb6814a 100644 --- a/glib/gbookmarkfile.c +++ b/glib/gbookmarkfile.c @@ -60,13 +60,12 @@ * like its MIME type, the application that is registering the bookmark and * the icon that should be used to represent the bookmark. The data is stored * using the - * Desktop Bookmark - * Specification. + * [Desktop Bookmark Specification](http://www.gnome.org/~ebassi/bookmark-spec). * * The syntax of the bookmark files is described in detail inside the Desktop * Bookmark Specification, here is a quick summary: bookmark files use a - * sub-class of the XML Bookmark Exchange Language - * specification, consisting of valid UTF-8 encoded XML, under the + * sub-class of the XML Bookmark Exchange Language specification, + * consisting of valid UTF-8 encoded XML, under the * xbel root element; each bookmark is stored inside a * bookmark element, using its URI: no relative paths can * be used inside a bookmark file. The bookmark may have a user defined title @@ -80,7 +79,8 @@ * registered; the URI and MIME type of an icon, to be used when displaying * the bookmark inside a GUI. * - * Here is an example of a bookmark file: bookmarks.xbel + * Here is an example of a bookmark file: + * [bookmarks.xbel](https://git.gnome.org/browse/glib/tree/glib/tests/bookmarks.xbel) * * A bookmark file might contain more than one bookmark; each bookmark * is accessed through its URI. diff --git a/glib/ghash.c b/glib/ghash.c index 8a99ff3..d427617 100644 --- a/glib/ghash.c +++ b/glib/ghash.c @@ -126,7 +126,8 @@ * a more secure hash function when using a GHashTable with keys * that originate in untrusted data (such as HTTP requests). * Using g_str_hash() in that situation might make your application - * vulerable to Algorithmic Complexity Attacks. + * vulerable to + * [Algorithmic Complexity Attacks](https://lwn.net/Articles/474912/). * * The key to choosing a good hash is unpredictability. Even * cryptographic hashes are very easy to find collisions for when the diff --git a/glib/ghmac.c b/glib/ghmac.c index 7f717a2..874383e 100644 --- a/glib/ghmac.c +++ b/glib/ghmac.c @@ -42,7 +42,8 @@ * HMACs should be used when producing a cookie or hash based on data * and a key. Simple mechanisms for using SHA1 and other algorithms to * digest a key and data together are vulnerable to various security - * issues. HMAC + * issues. + * [HMAC](http://en.wikipedia.org/wiki/HMAC) * uses algorithms like SHA1 in a secure way to produce a digest of a * key and data. * diff --git a/glib/ghostutils.c b/glib/ghostutils.c index 2af7d0c..3182a12 100644 --- a/glib/ghostutils.c +++ b/glib/ghostutils.c @@ -38,9 +38,9 @@ * converting between Unicode and ASCII-encoded forms of * Internationalized Domain Names (IDNs). * - * The Internationalized Domain - * Names for Applications (IDNA) standards allow for the use + * The + * [Internationalized Domain Names for Applications (IDNA)](http://www.ietf.org/rfc/rfc3490.txt) + * standards allow for the use * of Unicode domain names in applications, while providing * backward-compatibility with the old ASCII-only DNS, by defining an * ASCII-Compatible Encoding of any given Unicode name, which can be diff --git a/glib/gkeyfile.c b/glib/gkeyfile.c index 71910cb..653ac98 100644 --- a/glib/gkeyfile.c +++ b/glib/gkeyfile.c @@ -77,14 +77,13 @@ * key-value pairs, which we call key files for * lack of a better name. Several freedesktop.org specifications use * key files now, e.g the - * Desktop - * Entry Specification and the - * Icon - * Theme Specification. + * [Desktop Entry Specification](http://freedesktop.org/Standards/desktop-entry-spec) + * and the + * [Icon Theme Specification](http://freedesktop.org/Standards/icon-theme-spec). * * The syntax of key files is described in detail in the - * Desktop - * Entry Specification, here is a quick summary: Key files + * [Desktop Entry Specification](http://freedesktop.org/Standards/desktop-entry-spec), + * here is a quick summary: Key files * consists of groups of key-value pairs, interspersed with comments. * * |[ @@ -150,8 +149,8 @@ * true and false (in lower case) are allowed. * * Note that in contrast to the - * Desktop - * Entry Specification, groups in key files may contain the same + * [Desktop Entry Specification](http://freedesktop.org/Standards/desktop-entry-spec), + * groups in key files may contain the same * key multiple times; the last entry wins. Key files may also contain * multiple groups with the same name; they are merged together. * Another difference is that keys and group names in key files are not @@ -199,8 +198,8 @@ * G_KEY_FILE_DESKTOP_GROUP: * * The name of the main group of a desktop entry file, as defined in the - * Desktop - * Entry Specification. Consult the specification for more + * [Desktop Entry Specification](http://freedesktop.org/Standards/desktop-entry-spec). + * Consult the specification for more * details about the meanings of the keys below. * * Since: 2.14 @@ -368,9 +367,8 @@ * G_KEY_FILE_DESKTOP_KEY_STARTUP_NOTIFY: * * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a boolean - * stating whether the application supports the Startup - * Notification Protocol Specification. + * stating whether the application supports the + * [Startup Notification Protocol Specification](http://www.freedesktop.org/Standards/startup-notification-spec). * * Since: 2.14 */ diff --git a/glib/gmarkup.c b/glib/gmarkup.c index 785d0b1..d7fde2e 100644 --- a/glib/gmarkup.c +++ b/glib/gmarkup.c @@ -40,8 +40,7 @@ /** * SECTION:markup * @Title: Simple XML Subset Parser * @Short_description: parses a subset of XML - * @See_also: XML - * Specification + * @See_also: [XML Specification](http://www.w3.org/TR/REC-xml/) * * The "GMarkup" parser is intended to parse a simple markup format * that's a subset of XML. This is a small, efficient, easy-to-use @@ -57,8 +56,9 @@ * the parser may accept documents that an XML parser would not. * However, XML documents which are not well-formed (which is a * weaker condition than being valid. See the - * XML specification - * for definitions of these terms.) are not considered valid GMarkup documents. + * [XML specification](http://www.w3.org/TR/REC-xml/) + * for definitions of these terms.) are not considered valid GMarkup + * documents. * * Simplifications to XML include: * diff --git a/glib/gmessages.c b/glib/gmessages.c index d1a4176..61d3b1d 100644 --- a/glib/gmessages.c +++ b/glib/gmessages.c @@ -174,8 +174,8 @@ * A convenience function/macro to log a warning message. * * You can make warnings fatal at runtime by setting the `G_DEBUG` - * environment variable (see Running - * GLib Applications). + * environment variable (see + * [Running GLib Applications](glib-running.html)). * * If g_log_default_handler() is used as the log handler function, * a newline character will automatically be appended to @..., and @@ -196,7 +196,7 @@ * * You can also make critical warnings fatal at runtime by * setting the `G_DEBUG` environment variable (see - * Running GLib Applications). + * [Running GLib Applications](glib-running.html)). * * If g_log_default_handler() is used as the log handler function, a new-line * character will automatically be appended to @..., and need not be entered @@ -450,7 +450,7 @@ g_log_domain_get_handler_L (GLogDomain *domain, * * You can also make some message levels fatal at runtime by setting * the `G_DEBUG` environment variable (see - * Running GLib Applications). + * [Running GLib Applications](glib-running.html)). * * Returns: the old fatal mask */ diff --git a/glib/grand.c b/glib/grand.c index 9fd6e89..75b72d0 100644 --- a/glib/grand.c +++ b/glib/grand.c @@ -78,9 +78,8 @@ * * GRand uses the Mersenne Twister PRNG, which was originally * developed by Makoto Matsumoto and Takuji Nishimura. Further - * information can be found at - * http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/emt.html. + * information can be found at + * [this page](http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/emt.html). * * If you just need a random number, you simply call the g_random_* * functions, which will create a globally used #GRand and use the diff --git a/glib/gregex.c b/glib/gregex.c index 35b139e..5f1dedf 100644 --- a/glib/gregex.c +++ b/glib/gregex.c @@ -98,7 +98,7 @@ * '\U' always matches 'U' instead of being an error in the pattern. Finally, * pattern matching is modified so that back references to an unset subpattern * group produces a match with the empty string instead of an error. See - * man:pcreapi(3) for more information. + * pcreapi(3) for more information. * * Creating and manipulating the same #GRegex structure from different * threads is not a problem as #GRegex does not modify its internal @@ -106,8 +106,9 @@ * is not threadsafe. * * The regular expressions low-level functionalities are obtained through - * the excellent PCRE library - * written by Philip Hazel. + * the excellent + * [PCRE](http://www.pcre.org/) + * library written by Philip Hazel. */ /* Mask of all the possible values for GRegexCompileFlags. */ @@ -878,7 +879,7 @@ g_match_info_get_match_count (const GMatchInfo *match_info) * There were formerly some restrictions on the pattern for partial matching. * The restrictions no longer apply. * - * See man:pcrepartial for more information on partial matching. + * See pcrepartial(3) for more information on partial matching. * * Returns: %TRUE if the match was partial, %FALSE otherwise * diff --git a/glib/gslice.c b/glib/gslice.c index 7364108..d000fad 100644 --- a/glib/gslice.c +++ b/glib/gslice.c @@ -66,9 +66,11 @@ * * To achieve these goals, the slice allocator uses a sophisticated, * layered design that has been inspired by Bonwick's slab allocator - * ([Bonwick94] Jeff Bonwick, The slab allocator: An object-caching kernel + * ([Bonwick94](http://citeseer.ist.psu.edu/bonwick94slab.html) + * Jeff Bonwick, The slab allocator: An object-caching kernel * memory allocator. USENIX 1994, and - * [Bonwick01] Bonwick and Jonathan Adams, Magazines and vmem: Extending the + * [Bonwick01](http://citeseer.ist.psu.edu/bonwick01magazines.html) + * Bonwick and Jonathan Adams, Magazines and vmem: Extending the * slab allocator to many cpu's and arbitrary resources. USENIX 2001) * * It uses posix_memalign() to optimize allocations of many equally-sized diff --git a/glib/gtimer.c b/glib/gtimer.c index 3635997..b600a57 100644 --- a/glib/gtimer.c +++ b/glib/gtimer.c @@ -482,11 +482,11 @@ g_time_val_from_iso8601 (const gchar *iso_date, * "YYYY-MM-DDTHH:MM:SSZ" or "YYYY-MM-DDTHH:MM:SS.fffffZ". * * This corresponds to the Internet date/time format defined by - * RFC 3339, and - * to either of the two most-precise formats defined by - * the W3C Note - * "Date and Time Formats". Both of these documents are profiles of - * ISO 8601. + * [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt), + * and to either of the two most-precise formats defined by + * the W3C Note + * [Date and Time Formats](http://www.w3.org/TR/NOTE-datetime-19980827). + * Both of these documents are profiles of ISO 8601. * * Use g_date_time_format() or g_strdup_printf() if a different * variation of ISO 8601 format is required. diff --git a/glib/gtimezone.c b/glib/gtimezone.c index ef2f9e8..03a48b8 100644 --- a/glib/gtimezone.c +++ b/glib/gtimezone.c @@ -1351,17 +1351,16 @@ rules_from_identifier (const gchar *identifier, * available and it is greater than 2037, then it will followed * instead. * - * See RFC3339 - * §5.6 for a precise definition of valid RFC3339 time offsets + * See + * [RFC3339 §5.6](http://tools.ietf.org/html/rfc3339#section-5.6) + * for a precise definition of valid RFC3339 time offsets * (the time-offset expansion) and ISO 8601 for the - * full list of valid time offsets. See The - * GNU C Library manual for an explanation of the possible - * values of the `TZ` environment variable. See - * Microsoft Time Zone Index Values for the list of time zones - * on Windows. + * full list of valid time offsets. See + * [The GNU C Library manual](http://www.gnu.org/s/libc/manual/html_node/TZ-Variable.html) + * for an explanation of the possible + * values of the `TZ` environment variable. See + * [Microsoft Time Zone Index Values](http://msdn.microsoft.com/en-us/library/ms912391%28v=winembedded.11%29.aspx) + * for the list of time zones on Windows. * * You should release the return value by calling g_time_zone_unref() * when you are done with it. diff --git a/glib/gunidecomp.c b/glib/gunidecomp.c index 2de3dd0..998798a 100644 --- a/glib/gunidecomp.c +++ b/glib/gunidecomp.c @@ -35,7 +35,7 @@ * * The implementations of the Unicode functions in GLib are based * on the Unicode Character Data tables, which are available from - * www.unicode.org. + * [www.unicode.org](http://www.unicode.org/). * GLib 2.8 supports Unicode 4.0, GLib 2.10 supports Unicode 4.1, * GLib 2.12 supports Unicode 5.0, GLib 2.16.3 supports Unicode 5.1, * GLib 2.30 supports Unicode 6.0. @@ -595,7 +595,8 @@ decompose_hangul_step (gunichar ch, * recursively call this function on @a. Or use * g_unichar_fully_decompose(). * - * See UAX#15 + * See + * [UAX#15](http://unicode.org/reports/tr15/) * for details. * * Returns: %TRUE if the character could be decomposed @@ -661,7 +662,8 @@ g_unichar_decompose (gunichar ch, * * If @a and @b do not compose a new character, @ch is set to zero. * - * See UAX#15 + * See + * [UAX#15](http://unicode.org/reports/tr15/) * for details. * * Returns: %TRUE if the characters could be composed @@ -703,7 +705,8 @@ g_unichar_compose (gunichar a, * decompositions, so that is the size recommended. This is provided * as %G_UNICHAR_MAX_DECOMPOSITION_LENGTH. * - * See UAX#15 + * See + * [UAX#15](http://unicode.org/reports/tr15/) * for details. * * Return value: the length of the full decomposition. diff --git a/glib/guniprop.c b/glib/guniprop.c index d0f8795..548d4da 100644 --- a/glib/guniprop.c +++ b/glib/guniprop.c @@ -492,9 +492,9 @@ g_unichar_iswide (gunichar c) * Determines if a character is typically rendered in a double-width * cell under legacy East Asian locales. If a character is wide according to * g_unichar_iswide(), then it is also reported wide with this function, but - * the converse is not necessarily true. See the - * Unicode Standard - * Annex #11 for details. + * the converse is not necessarily true. See the + * [Unicode Standard Annex #11](http://www.unicode.org/reports/tr11/) + * for details. * * If a character passes the g_unichar_iswide() test then it will also pass * this test, but not the other way around. Note that some characters may @@ -1454,8 +1454,9 @@ static const guint32 iso15924_tags[] = * big-endian fashion. That is, the code returned for Arabic is * 0x41726162 (0x41 is ASCII code for 'A', 0x72 is ASCII code for 'r', etc). * - * See Codes for the - * representation of names of scripts for details. + * See + * [Codes for the representation of names of scripts](http://unicode.org/iso15924/codelists.html) + * for details. * * Return value: the ISO 15924 code for @script, encoded as an integer, * of zero if @script is %G_UNICODE_SCRIPT_INVALID_CODE or @@ -1485,8 +1486,9 @@ g_unicode_script_to_iso15924 (GUnicodeScript script) * big-endian fashion. That is, the code expected for Arabic is * 0x41726162 (0x41 is ASCII code for 'A', 0x72 is ASCII code for 'r', etc). * - * See Codes for the - * representation of names of scripts for details. + * See + * [Codes for the representation of names of scripts](http://unicode.org/iso15924/codelists.html) + * for details. * * Return value: the Unicode script for @iso15924, or * of %G_UNICODE_SCRIPT_INVALID_CODE if @iso15924 is zero and diff --git a/glib/gurifuncs.c b/glib/gurifuncs.c index 33d9eca..44cf82a 100644 --- a/glib/gurifuncs.c +++ b/glib/gurifuncs.c @@ -37,8 +37,9 @@ * @short_description: manipulating URIs * * Functions for manipulating Universal Resource Identifiers (URIs) as - * defined by - * RFC 3986. It is highly recommended that you have read and + * defined by + * [RFC 3986](http://www.ietf.org/rfc/rfc3986.txt). + * It is highly recommended that you have read and * understand RFC 3986 for understanding this API. */ diff --git a/glib/gutils.c b/glib/gutils.c index e60a2f1..a3bf680 100644 --- a/glib/gutils.c +++ b/glib/gutils.c @@ -1134,10 +1134,10 @@ g_set_application_name (const gchar *application_name) * Returns a base directory in which to access application data such * as icons that is customized for a particular user. * - * On UNIX platforms this is determined using the mechanisms described in - * the - * XDG Base Directory Specification. - * In this case the directory retrieved will be XDG_DATA_HOME. + * On UNIX platforms this is determined using the mechanisms described + * in the + * [XDG Base Directory Specification](http://www.freedesktop.org/Standards/basedir-spec). + * In this case the directory retrieved will be `XDG_DATA_HOME`. * * On Windows this is the folder to use for local (as opposed to * roaming) application data. See documentation for @@ -1220,10 +1220,10 @@ g_init_user_config_dir (void) * Returns a base directory in which to store user-specific application * configuration information such as user preferences and settings. * - * On UNIX platforms this is determined using the mechanisms described in - * the - * XDG Base Directory Specification. - * In this case the directory retrieved will be XDG_CONFIG_HOME. + * On UNIX platforms this is determined using the mechanisms described + * in the + * [XDG Base Directory Specification](http://www.freedesktop.org/Standards/basedir-spec). + * In this case the directory retrieved will be `XDG_CONFIG_HOME`. * * On Windows this is the folder to use for local (as opposed to * roaming) application data. See documentation for @@ -1252,9 +1252,9 @@ g_get_user_config_dir (void) * Returns a base directory in which to store non-essential, cached * data specific to particular user. * - * On UNIX platforms this is determined using the mechanisms described in - * the - * XDG Base Directory Specification. + * On UNIX platforms this is determined using the mechanisms described + * in the + * [XDG Base Directory Specification](http://www.freedesktop.org/Standards/basedir-spec). * In this case the directory retrieved will be XDG_CACHE_HOME. * * On Windows is the directory that serves as a common repository for @@ -1308,9 +1308,10 @@ g_get_user_cache_dir (void) * Returns a directory that is unique to the current user on the local * system. * - * On UNIX platforms this is determined using the mechanisms described in - * the - * XDG Base Directory Specification. This is the directory + * On UNIX platforms this is determined using the mechanisms described + * in the + * [XDG Base Directory Specification](http://www.freedesktop.org/Standards/basedir-spec). + * This is the directory * specified in the `XDG_RUNTIME_DIR` environment variable. * In the case that this variable is not set, GLib will issue a warning * message to stderr and return the value of g_get_user_cache_dir(). @@ -1893,9 +1894,9 @@ g_win32_get_system_data_dirs_for_module (void (*address_of_function)(void)) * Returns an ordered list of base directories in which to access * system-wide application data. * - * On UNIX platforms this is determined using the mechanisms described in - * the - * XDG Base Directory Specification + * On UNIX platforms this is determined using the mechanisms described + * in the + * [XDG Base Directory Specification](http://www.freedesktop.org/Standards/basedir-spec) * In this case the list of directories retrieved will be XDG_DATA_DIRS. * * On Windows the first elements in the list are the Application Data @@ -1960,10 +1961,10 @@ g_get_system_data_dirs (void) * Returns an ordered list of base directories in which to access * system-wide configuration information. * - * On UNIX platforms this is determined using the mechanisms described in - * the - * XDG Base Directory Specification. - * In this case the list of directories retrieved will be XDG_CONFIG_DIRS. + * On UNIX platforms this is determined using the mechanisms described + * in the + * [XDG Base Directory Specification](http://www.freedesktop.org/Standards/basedir-spec). + * In this case the list of directories retrieved will be `XDG_CONFIG_DIRS`. * * On Windows is the directory that contains application data for all users. * A typical path is C:\Documents and Settings\All Users\Application Data. diff --git a/glib/gvarianttype.c b/glib/gvarianttype.c index 4067ecd..6f70089 100644 --- a/glib/gvarianttype.c +++ b/glib/gvarianttype.c @@ -34,11 +34,11 @@ * @short_description: introduction to the GVariant type system * @see_also: #GVariantType, #GVariant * - * This section introduces the GVariant type system. It is based, in - * large part, on the D-Bus type system, with two major changes and some minor - * lifting of restrictions. The DBus - * specification, therefore, provides a significant amount of + * This section introduces the GVariant type system. It is based, in + * large part, on the D-Bus type system, with two major changes and + * some minor lifting of restrictions. The + * [D-Bus specification](http://dbus.freedesktop.org/doc/dbus-specification.html), + * therefore, provides a significant amount of * information that is useful when working with GVariant. * * The first major change with respect to the D-Bus type system is the diff --git a/gobject/gclosure.c b/gobject/gclosure.c index bd58939..fa1c1a9 100644 --- a/gobject/gclosure.c +++ b/gobject/gclosure.c @@ -1368,8 +1368,8 @@ va_to_ffi_type (GType gtype, * marshaller, see g_closure_set_marshal() and * g_closure_set_meta_marshal() * - * A generic marshaller function implemented via libffi. + * A generic marshaller function implemented via + * [libffi](http://sourceware.org/libffi/). * * Since: 2.30 */ -- 2.7.4