From 20f4d1820b8d4d0fc4447188e33efffd6d4a88d8 Mon Sep 17 00:00:00 2001 From: William Jon McCann Date: Wed, 19 Feb 2014 19:35:23 -0500 Subject: [PATCH] docs: use "Returns:" consistently Instead of "Return value:". --- gio/gactiongroup.c | 8 ++-- gio/gappinfo.c | 2 +- gio/gcancellable.c | 2 +- gio/gdesktopappinfo.c | 2 +- gio/gfileenumerator.c | 4 +- gio/gfilterinputstream.c | 2 +- gio/gfilteroutputstream.c | 2 +- gio/ginetaddressmask.c | 12 ++--- gio/ginetsocketaddress.c | 4 +- gio/ginitable.c | 6 +-- gio/ginputstream.c | 12 ++--- gio/gioerror.c | 2 +- gio/giomodule.c | 4 +- gio/giostream.c | 4 +- gio/gmemoryoutputstream.c | 2 +- gio/gnetworkaddress.c | 12 ++--- gio/gnetworkmonitor.c | 6 +-- gio/gnetworkservice.c | 10 ++-- gio/goutputstream.c | 16 +++---- gio/gpollableinputstream.c | 2 +- gio/gpollableoutputstream.c | 2 +- gio/gpollableutils.c | 6 +-- gio/gproxy.c | 8 ++-- gio/gproxyresolver.c | 8 ++-- gio/gresolver.c | 20 ++++---- gio/gresource.c | 8 ++-- gio/gsocketaddressenumerator.c | 4 +- gio/gsocketconnectable.c | 4 +- gio/gsrvtarget.c | 14 +++--- gio/gtask.c | 6 +-- gio/gtcpwrapperconnection.c | 4 +- gio/gtlsbackend.c | 12 ++--- gio/gtlscertificate.c | 14 +++--- gio/gtlsclientconnection.c | 10 ++-- gio/gtlsconnection.c | 24 +++++----- gio/gtlsdatabase.c | 16 +++---- gio/gtlsfiledatabase.c | 2 +- gio/gtlspassword.c | 6 +-- gio/gtlsserverconnection.c | 2 +- gio/gunixinputstream.c | 4 +- gio/gunixoutputstream.c | 4 +- gio/gwin32inputstream.c | 4 +- gio/gwin32outputstream.c | 4 +- gio/gwin32volumemonitor.c | 2 +- gio/inotify/inotify-helper.c | 2 +- glib/deprecated/gcompletion.c | 2 +- glib/gasyncqueue.c | 24 +++++----- glib/gbase64.c | 12 ++--- glib/gbookmarkfile.c | 54 ++++++++++----------- glib/gcharset.c | 6 +-- glib/gchecksum.c | 14 +++--- glib/gconvert.c | 30 ++++++------ glib/gdataset.c | 2 +- glib/gdatetime.c | 46 +++++++++--------- glib/gdir.c | 4 +- glib/genviron.c | 8 ++-- glib/gerror.c | 8 ++-- glib/gfileutils.c | 32 ++++++------- glib/ggettext.c | 2 +- glib/ghash.c | 28 +++++------ glib/ghmac.c | 12 ++--- glib/ghostutils.c | 10 ++-- glib/giochannel.c | 46 +++++++++--------- glib/gkeyfile.c | 44 ++++++++--------- glib/gmain.c | 88 +++++++++++++++++----------------- glib/gmappedfile.c | 6 +-- glib/gmarkup.c | 16 +++---- glib/gmem.c | 2 +- glib/gnode.c | 2 +- glib/goption.c | 6 +-- glib/gpoll.c | 2 +- glib/gqueue.c | 28 +++++------ glib/grand.c | 24 +++++----- glib/gsequence.c | 48 +++++++++---------- glib/gshell.c | 6 +-- glib/gspawn.c | 10 ++-- glib/gstrfuncs.c | 56 +++++++++++----------- glib/gstring.c | 18 +++---- glib/gstringchunk.c | 2 +- glib/gtestutils.h | 2 +- glib/gthreadpool.c | 18 +++---- glib/gtimer.c | 4 +- glib/gtree.c | 18 +++---- glib/gunibreak.c | 2 +- glib/gunicollate.c | 6 +-- glib/gunidecomp.c | 8 ++-- glib/guniprop.c | 60 +++++++++++------------ glib/gutf8.c | 42 ++++++++-------- glib/gutils.c | 16 +++---- glib/gversion.c | 2 +- glib/gwin32.c | 2 +- gobject/gbinding.c | 16 +++---- gobject/gbinding.h | 2 +- 93 files changed, 600 insertions(+), 600 deletions(-) diff --git a/gio/gactiongroup.c b/gio/gactiongroup.c index 3426c74d7..212df73fb 100644 --- a/gio/gactiongroup.c +++ b/gio/gactiongroup.c @@ -389,7 +389,7 @@ g_action_group_has_action (GActionGroup *action_group, * possible for an action to be removed and for a new action to be added * with the same name but a different parameter type. * - * Return value: the parameter type + * Returns: the parameter type * * Since: 2.28 **/ @@ -463,7 +463,7 @@ g_action_group_get_action_state_type (GActionGroup *action_group, * The return value (if non-%NULL) should be freed with * g_variant_unref() when it is no longer required. * - * Return value: (transfer full): the state range hint + * Returns: (transfer full): the state range hint * * Since: 2.28 **/ @@ -487,7 +487,7 @@ g_action_group_get_action_state_hint (GActionGroup *action_group, * An action must be enabled in order to be activated or in order to * have its state changed from outside callers. * - * Return value: whether or not the action is currently enabled + * Returns: whether or not the action is currently enabled * * Since: 2.28 **/ @@ -515,7 +515,7 @@ g_action_group_get_action_enabled (GActionGroup *action_group, * The return value (if non-%NULL) should be freed with * g_variant_unref() when it is no longer required. * - * Return value: (allow-none): the current state of the action + * Returns: (allow-none): the current state of the action * * Since: 2.28 **/ diff --git a/gio/gappinfo.c b/gio/gappinfo.c index 0bae300c1..474f34210 100644 --- a/gio/gappinfo.c +++ b/gio/gappinfo.c @@ -925,7 +925,7 @@ g_app_launch_context_unsetenv (GAppLaunchContext *context, * This is a %NULL-terminated array of strings, where each string has * the form `KEY=VALUE`. * - * Return value: (array zero-terminated=1) (transfer full): the + * Returns: (array zero-terminated=1) (transfer full): the * child's environment * * Since: 2.32 diff --git a/gio/gcancellable.c b/gio/gcancellable.c index 80ebfbfa9..e7c48c93e 100644 --- a/gio/gcancellable.c +++ b/gio/gcancellable.c @@ -715,7 +715,7 @@ static GSourceFuncs cancellable_source_funcs = * For convenience, you can call this with a %NULL #GCancellable, * in which case the source will never trigger. * - * Return value: (transfer full): the new #GSource. + * Returns: (transfer full): the new #GSource. * * Since: 2.28 */ diff --git a/gio/gdesktopappinfo.c b/gio/gdesktopappinfo.c index 365d9bae2..91ebc77e4 100644 --- a/gio/gdesktopappinfo.c +++ b/gio/gdesktopappinfo.c @@ -4188,7 +4188,7 @@ append_desktop_entry (GList *list, * * Optionally doesn't list the desktop ids given in the @except * - * Return value: a #GList containing the desktop ids which claim + * Returns: a #GList containing the desktop ids which claim * to handle @mime_type. */ static GList * diff --git a/gio/gfileenumerator.c b/gio/gfileenumerator.c index 53783c81d..ae2965fb1 100644 --- a/gio/gfileenumerator.c +++ b/gio/gfileenumerator.c @@ -191,7 +191,7 @@ g_file_enumerator_init (GFileEnumerator *enumerator) * enumerator is at the end, %NULL will be returned and @error will * be unset. * - * Return value: (transfer full): A #GFileInfo or %NULL on error or end of enumerator. + * Returns: (transfer full): A #GFileInfo or %NULL on error or end of enumerator. * Free the returned object with g_object_unref() when no longer needed. **/ GFileInfo * @@ -254,7 +254,7 @@ g_file_enumerator_next_file (GFileEnumerator *enumerator, * is dropped, but you might want to call this function to make * sure resources are released as early as possible. * - * Return value: #TRUE on success or #FALSE on error. + * Returns: #TRUE on success or #FALSE on error. **/ gboolean g_file_enumerator_close (GFileEnumerator *enumerator, diff --git a/gio/gfilterinputstream.c b/gio/gfilterinputstream.c index 326222a9d..1c69560e7 100644 --- a/gio/gfilterinputstream.c +++ b/gio/gfilterinputstream.c @@ -206,7 +206,7 @@ g_filter_input_stream_get_base_stream (GFilterInputStream *stream) * Returns whether the base stream will be closed when @stream is * closed. * - * Return value: %TRUE if the base stream will be closed. + * Returns: %TRUE if the base stream will be closed. **/ gboolean g_filter_input_stream_get_close_base_stream (GFilterInputStream *stream) diff --git a/gio/gfilteroutputstream.c b/gio/gfilteroutputstream.c index abe9c0782..9089579e3 100644 --- a/gio/gfilteroutputstream.c +++ b/gio/gfilteroutputstream.c @@ -210,7 +210,7 @@ g_filter_output_stream_get_base_stream (GFilterOutputStream *stream) * Returns whether the base stream will be closed when @stream is * closed. * - * Return value: %TRUE if the base stream will be closed. + * Returns: %TRUE if the base stream will be closed. **/ gboolean g_filter_output_stream_get_close_base_stream (GFilterOutputStream *stream) diff --git a/gio/ginetaddressmask.c b/gio/ginetaddressmask.c index 38fada014..b33c2f963 100644 --- a/gio/ginetaddressmask.c +++ b/gio/ginetaddressmask.c @@ -330,7 +330,7 @@ g_inet_address_mask_new_from_string (const gchar *mask_string, * * Converts @mask back to its corresponding string form. * - * Return value: a string corresponding to @mask. + * Returns: a string corresponding to @mask. * * Since: 2.32 */ @@ -358,7 +358,7 @@ g_inet_address_mask_to_string (GInetAddressMask *mask) * * Gets the #GSocketFamily of @mask's address * - * Return value: the #GSocketFamily of @mask's address + * Returns: the #GSocketFamily of @mask's address * * Since: 2.32 */ @@ -376,7 +376,7 @@ g_inet_address_mask_get_family (GInetAddressMask *mask) * * Gets @mask's base address * - * Return value: (transfer none): @mask's base address + * Returns: (transfer none): @mask's base address * * Since: 2.32 */ @@ -394,7 +394,7 @@ g_inet_address_mask_get_address (GInetAddressMask *mask) * * Gets @mask's length * - * Return value: @mask's length + * Returns: @mask's length * * Since: 2.32 */ @@ -413,7 +413,7 @@ g_inet_address_mask_get_length (GInetAddressMask *mask) * * Tests if @address falls within the range described by @mask. * - * Return value: whether @address falls within the range described by + * Returns: whether @address falls within the range described by * @mask. * * Since: 2.32 @@ -457,7 +457,7 @@ g_inet_address_mask_matches (GInetAddressMask *mask, * * Tests if @mask and @mask2 are the same mask. * - * Return value: whether @mask and @mask2 are the same mask + * Returns: whether @mask and @mask2 are the same mask * * Since: 2.32 */ diff --git a/gio/ginetsocketaddress.c b/gio/ginetsocketaddress.c index 6301e920d..b2a8a2f59 100644 --- a/gio/ginetsocketaddress.c +++ b/gio/ginetsocketaddress.c @@ -447,7 +447,7 @@ g_inet_socket_address_get_port (GInetSocketAddress *address) * Gets the `sin6_flowinfo` field from @address, * which must be an IPv6 address. * - * Return value: the flowinfo field + * Returns: the flowinfo field * * Since: 2.32 */ @@ -467,7 +467,7 @@ g_inet_socket_address_get_flowinfo (GInetSocketAddress *address) * Gets the `sin6_scope_id` field from @address, * which must be an IPv6 address. * - * Return value: the scope id field + * Returns: the scope id field * * Since: 2.32 */ diff --git a/gio/ginitable.c b/gio/ginitable.c index 38f46e731..23d6069f3 100644 --- a/gio/ginitable.c +++ b/gio/ginitable.c @@ -127,7 +127,7 @@ g_initable_init (GInitable *initable, * similar to g_object_new() but also initializes the object * and returns %NULL, setting an error on failure. * - * Return value: (type GObject.Object) (transfer full): a newly allocated + * Returns: (type GObject.Object) (transfer full): a newly allocated * #GObject, or %NULL on error * * Since: 2.22 @@ -164,7 +164,7 @@ g_initable_new (GType object_type, * similar to g_object_newv() but also initializes the object * and returns %NULL, setting an error on failure. * - * Return value: (type GObject.Object) (transfer full): a newly allocated + * Returns: (type GObject.Object) (transfer full): a newly allocated * #GObject, or %NULL on error * * Since: 2.22 @@ -205,7 +205,7 @@ g_initable_newv (GType object_type, * similar to g_object_new_valist() but also initializes the object * and returns %NULL, setting an error on failure. * - * Return value: (type GObject.Object) (transfer full): a newly allocated + * Returns: (type GObject.Object) (transfer full): a newly allocated * #GObject, or %NULL on error * * Since: 2.22 diff --git a/gio/ginputstream.c b/gio/ginputstream.c index f72828541..0bf067ee3 100644 --- a/gio/ginputstream.c +++ b/gio/ginputstream.c @@ -149,7 +149,7 @@ g_input_stream_init (GInputStream *stream) * * On error -1 is returned and @error is set accordingly. * - * Return value: Number of bytes read, or -1 on error, or 0 on end of file. + * Returns: Number of bytes read, or -1 on error, or 0 on end of file. **/ gssize g_input_stream_read (GInputStream *stream, @@ -223,7 +223,7 @@ g_input_stream_read (GInputStream *stream, * is set to indicate the error status, @bytes_read is updated to contain * the number of bytes read into @buffer before the error occurred. * - * Return value: %TRUE on success, %FALSE if there was an error + * Returns: %TRUE on success, %FALSE if there was an error **/ gboolean g_input_stream_read_all (GInputStream *stream, @@ -294,7 +294,7 @@ g_input_stream_read_all (GInputStream *stream, * * On error %NULL is returned and @error is set accordingly. * - * Return value: a new #GBytes, or %NULL on error + * Returns: a new #GBytes, or %NULL on error **/ GBytes * g_input_stream_read_bytes (GInputStream *stream, @@ -343,7 +343,7 @@ g_input_stream_read_bytes (GInputStream *stream, * operation was partially finished when the operation was cancelled the * partial result will be returned, without an error. * - * Return value: Number of bytes skipped, or -1 on error + * Returns: Number of bytes skipped, or -1 on error **/ gssize g_input_stream_skip (GInputStream *stream, @@ -468,7 +468,7 @@ g_input_stream_real_skip (GInputStream *stream, * Cancelling a close will still leave the stream closed, but some streams * can use a faster close that doesn't block to e.g. check errors. * - * Return value: %TRUE on success, %FALSE on failure + * Returns: %TRUE on success, %FALSE on failure **/ gboolean g_input_stream_close (GInputStream *stream, @@ -995,7 +995,7 @@ g_input_stream_has_pending (GInputStream *stream) * already set or @stream is closed, it will return %FALSE and set * @error. * - * Return value: %TRUE if pending was previously unset and is now set. + * Returns: %TRUE if pending was previously unset and is now set. **/ gboolean g_input_stream_set_pending (GInputStream *stream, GError **error) diff --git a/gio/gioerror.c b/gio/gioerror.c index 053f13fcd..bbd51d9d1 100644 --- a/gio/gioerror.c +++ b/gio/gioerror.c @@ -36,7 +36,7 @@ * * Gets the GIO Error Quark. * - * Return value: a #GQuark. + * Returns: a #GQuark. **/ G_DEFINE_QUARK (g-io-error-quark, g_io_error) diff --git a/gio/giomodule.c b/gio/giomodule.c index ced8a6c60..18b7933ad 100644 --- a/gio/giomodule.c +++ b/gio/giomodule.c @@ -665,7 +665,7 @@ try_class (GIOExtension *extension, * The result is cached after it is generated the first time, and * the function is thread-safe. * - * Return value: (transfer none): an object implementing + * Returns: (transfer none): an object implementing * @extension_point, or %NULL if there are no usable * implementations. */ @@ -788,7 +788,7 @@ try_implementation (GIOExtension *extension, * The result is cached after it is generated the first time, and * the function is thread-safe. * - * Return value: (transfer none): an object implementing + * Returns: (transfer none): an object implementing * @extension_point, or %NULL if there are no usable * implementations. */ diff --git a/gio/giostream.c b/gio/giostream.c index 34b07fced..e64e66cec 100644 --- a/gio/giostream.c +++ b/gio/giostream.c @@ -262,7 +262,7 @@ g_io_stream_has_pending (GIOStream *stream) * already set or @stream is closed, it will return %FALSE and set * @error. * - * Return value: %TRUE if pending was previously unset and is now set. + * Returns: %TRUE if pending was previously unset and is now set. * * Since: 2.22 */ @@ -370,7 +370,7 @@ g_io_stream_real_close (GIOStream *stream, * The default implementation of this method just calls close on the * individual input/output streams. * - * Return value: %TRUE on success, %FALSE on failure + * Returns: %TRUE on success, %FALSE on failure * * Since: 2.22 */ diff --git a/gio/gmemoryoutputstream.c b/gio/gmemoryoutputstream.c index 740088f9d..9c83b7db6 100644 --- a/gio/gmemoryoutputstream.c +++ b/gio/gmemoryoutputstream.c @@ -379,7 +379,7 @@ g_memory_output_stream_init (GMemoryOutputStream *stream) * stream3 = g_memory_output_stream_new (data, 200, NULL, free); * ]| * - * Return value: A newly created #GMemoryOutputStream object. + * Returns: A newly created #GMemoryOutputStream object. **/ GOutputStream * g_memory_output_stream_new (gpointer data, diff --git a/gio/gnetworkaddress.c b/gio/gnetworkaddress.c index 094615b44..342a6b9ba 100644 --- a/gio/gnetworkaddress.c +++ b/gio/gnetworkaddress.c @@ -268,7 +268,7 @@ g_network_address_parse_sockaddr (GNetworkAddress *addr) * Creates a new #GSocketConnectable for connecting to the given * @hostname and @port. * - * Return value: (transfer full) (type GNetworkAddress): the new #GNetworkAddress + * Returns: (transfer full) (type GNetworkAddress): the new #GNetworkAddress * * Since: 2.22 */ @@ -310,7 +310,7 @@ g_network_address_new (const gchar *hostname, * is deprecated, because it depends on the contents of /etc/services, * which is generally quite sparse on platforms other than Linux.) * - * Return value: (transfer full): the new #GNetworkAddress, or %NULL on error + * Returns: (transfer full): the new #GNetworkAddress, or %NULL on error * * Since: 2.22 */ @@ -721,7 +721,7 @@ _g_uri_from_authority (const gchar *protocol, * g_network_address_parse() allows #GSocketClient to determine * when to use application-specific proxy protocols. * - * Return value: (transfer full): the new #GNetworkAddress, or %NULL on error + * Returns: (transfer full): the new #GNetworkAddress, or %NULL on error * * Since: 2.26 */ @@ -767,7 +767,7 @@ g_network_address_parse_uri (const gchar *uri, * Gets @addr's hostname. This might be either UTF-8 or ASCII-encoded, * depending on what @addr was created with. * - * Return value: @addr's hostname + * Returns: @addr's hostname * * Since: 2.22 */ @@ -785,7 +785,7 @@ g_network_address_get_hostname (GNetworkAddress *addr) * * Gets @addr's port number * - * Return value: @addr's port (which may be 0) + * Returns: @addr's port (which may be 0) * * Since: 2.22 */ @@ -803,7 +803,7 @@ g_network_address_get_port (GNetworkAddress *addr) * * Gets @addr's scheme * - * Return value: @addr's scheme (%NULL if not built from URI) + * Returns: @addr's scheme (%NULL if not built from URI) * * Since: 2.26 */ diff --git a/gio/gnetworkmonitor.c b/gio/gnetworkmonitor.c index d74bfa41b..79c7bd94f 100644 --- a/gio/gnetworkmonitor.c +++ b/gio/gnetworkmonitor.c @@ -85,7 +85,7 @@ g_network_monitor_get_default (void) * IPv6. It does not necessarily imply that the public Internet is * reachable. See #GNetworkMonitor:network-available for more details. * - * Return value: whether the network is available + * Returns: whether the network is available * * Since: 2.32 */ @@ -123,7 +123,7 @@ g_network_monitor_get_network_available (GNetworkMonitor *monitor) * trying to do multicast DNS on the local network), so if you do not * want to block, you should use g_network_monitor_can_reach_async(). * - * Return value: %TRUE if @connectable is reachable, %FALSE if not. + * Returns: %TRUE if @connectable is reachable, %FALSE if not. * * Since: 2.32 */ @@ -208,7 +208,7 @@ g_network_monitor_real_can_reach_finish (GNetworkMonitor *monitor, * Finishes an async network connectivity test. * See g_network_monitor_can_reach_async(). * - * Return value: %TRUE if network is reachable, %FALSE if not. + * Returns: %TRUE if network is reachable, %FALSE if not. */ gboolean g_network_monitor_can_reach_finish (GNetworkMonitor *monitor, diff --git a/gio/gnetworkservice.c b/gio/gnetworkservice.c index 744b3ca26..fb37620cb 100644 --- a/gio/gnetworkservice.c +++ b/gio/gnetworkservice.c @@ -241,7 +241,7 @@ g_network_service_get_property (GObject *object, * @protocol, and @domain. This will initially be unresolved; use the * #GSocketConnectable interface to resolve it. * - * Return value: (transfer full) (type GNetworkService): a new #GNetworkService + * Returns: (transfer full) (type GNetworkService): a new #GNetworkService * * Since: 2.22 */ @@ -263,7 +263,7 @@ g_network_service_new (const gchar *service, * * Gets @srv's service name (eg, "ldap"). * - * Return value: @srv's service name + * Returns: @srv's service name * * Since: 2.22 */ @@ -281,7 +281,7 @@ g_network_service_get_service (GNetworkService *srv) * * Gets @srv's protocol name (eg, "tcp"). * - * Return value: @srv's protocol name + * Returns: @srv's protocol name * * Since: 2.22 */ @@ -300,7 +300,7 @@ g_network_service_get_protocol (GNetworkService *srv) * Gets the domain that @srv serves. This might be either UTF-8 or * ASCII-encoded, depending on what @srv was created with. * - * Return value: @srv's domain name + * Returns: @srv's domain name * * Since: 2.22 */ @@ -319,7 +319,7 @@ g_network_service_get_domain (GNetworkService *srv) * Get's the URI scheme used to resolve proxies. By default, the service name * is used as scheme. * - * Return value: @srv's scheme name + * Returns: @srv's scheme name * * Since: 2.26 */ diff --git a/gio/goutputstream.c b/gio/goutputstream.c index adae2230a..e7b116736 100644 --- a/gio/goutputstream.c +++ b/gio/goutputstream.c @@ -176,7 +176,7 @@ g_output_stream_init (GOutputStream *stream) * * Virtual: write_fn * - * Return value: Number of bytes written, or -1 on error + * Returns: Number of bytes written, or -1 on error **/ gssize g_output_stream_write (GOutputStream *stream, @@ -249,7 +249,7 @@ g_output_stream_write (GOutputStream *stream, * is set to indicate the error status, @bytes_written is updated to contain * the number of bytes written into the stream before the error occurred. * - * Return value: %TRUE on success, %FALSE if there was an error + * Returns: %TRUE on success, %FALSE if there was an error **/ gboolean g_output_stream_write_all (GOutputStream *stream, @@ -314,7 +314,7 @@ g_output_stream_write_all (GOutputStream *stream, * * Since: 2.40 * - * Return value: %TRUE on success, %FALSE if there was an error + * Returns: %TRUE on success, %FALSE if there was an error **/ gboolean g_output_stream_printf (GOutputStream *stream, @@ -360,7 +360,7 @@ g_output_stream_printf (GOutputStream *stream, * * Since: 2.40 * - * Return value: %TRUE on success, %FALSE if there was an error + * Returns: %TRUE on success, %FALSE if there was an error **/ gboolean g_output_stream_vprintf (GOutputStream *stream, @@ -406,7 +406,7 @@ g_output_stream_vprintf (GOutputStream *stream, * #GBytes instance multiple times potentially can result in duplicated * data in the output stream. * - * Return value: Number of bytes written, or -1 on error + * Returns: Number of bytes written, or -1 on error **/ gssize g_output_stream_write_bytes (GOutputStream *stream, @@ -441,7 +441,7 @@ g_output_stream_write_bytes (GOutputStream *stream, * triggering the cancellable object from another thread. If the operation * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. * - * Return value: %TRUE on success, %FALSE on error + * Returns: %TRUE on success, %FALSE on error **/ gboolean g_output_stream_flush (GOutputStream *stream, @@ -692,7 +692,7 @@ g_output_stream_internal_close (GOutputStream *stream, * cancellation (as with any error) there is no guarantee that all written * data will reach the target. * - * Return value: %TRUE on success, %FALSE on failure + * Returns: %TRUE on success, %FALSE on failure **/ gboolean g_output_stream_close (GOutputStream *stream, @@ -1450,7 +1450,7 @@ g_output_stream_has_pending (GOutputStream *stream) * already set or @stream is closed, it will return %FALSE and set * @error. * - * Return value: %TRUE if pending was previously unset and is now set. + * Returns: %TRUE if pending was previously unset and is now set. **/ gboolean g_output_stream_set_pending (GOutputStream *stream, diff --git a/gio/gpollableinputstream.c b/gio/gpollableinputstream.c index 513bb4873..c640140e9 100644 --- a/gio/gpollableinputstream.c +++ b/gio/gpollableinputstream.c @@ -178,7 +178,7 @@ g_pollable_input_stream_default_read_nonblocking (GPollableInputStream *stream, * to having been cancelled. * * Virtual: read_nonblocking - * Return value: the number of bytes read, or -1 on error (including + * Returns: the number of bytes read, or -1 on error (including * %G_IO_ERROR_WOULD_BLOCK). */ gssize diff --git a/gio/gpollableoutputstream.c b/gio/gpollableoutputstream.c index a3a860773..c16b90aa5 100644 --- a/gio/gpollableoutputstream.c +++ b/gio/gpollableoutputstream.c @@ -179,7 +179,7 @@ g_pollable_output_stream_default_write_nonblocking (GPollableOutputStream *stre * to having been cancelled. * * Virtual: write_nonblocking - * Return value: the number of bytes written, or -1 on error (including + * Returns: the number of bytes written, or -1 on error (including * %G_IO_ERROR_WOULD_BLOCK). */ gssize diff --git a/gio/gpollableutils.c b/gio/gpollableutils.c index fbf351956..8a778f31f 100644 --- a/gio/gpollableutils.c +++ b/gio/gpollableutils.c @@ -101,7 +101,7 @@ static GSourceFuncs pollable_source_funcs = * anything on its own; use g_source_add_child_source() to add other * sources to it to cause it to trigger. * - * Return value: (transfer full): the new #GSource. + * Returns: (transfer full): the new #GSource. * * Since: 2.28 */ @@ -134,7 +134,7 @@ g_pollable_source_new (GObject *pollable_stream) * g_pollable_source_new(), but also attaching @child_source (with a * dummy callback), and @cancellable, if they are non-%NULL. * - * Return value: (transfer full): the new #GSource. + * Returns: (transfer full): the new #GSource. * * Since: 2.34 */ @@ -289,7 +289,7 @@ g_pollable_stream_write (GOutputStream *stream, * behavior is undefined. If @blocking is %TRUE, then @stream does not * need to be a #GPollableOutputStream. * - * Return value: %TRUE on success, %FALSE if there was an error + * Returns: %TRUE on success, %FALSE if there was an error * * Since: 2.34 */ diff --git a/gio/gproxy.c b/gio/gproxy.c index cf0ed6b77..bf5b1e28d 100644 --- a/gio/gproxy.c +++ b/gio/gproxy.c @@ -55,7 +55,7 @@ g_proxy_default_init (GProxyInterface *iface) * Lookup "gio-proxy" extension point for a proxy implementation that supports * specified protocol. * - * Return value: (transfer full): return a #GProxy or NULL if protocol + * Returns: (transfer full): return a #GProxy or NULL if protocol * is not supported. * * Since: 2.26 @@ -92,7 +92,7 @@ g_proxy_get_default_for_protocol (const gchar *protocol) * does the necessary handshake to connect to @proxy_address, and if * required, wraps the #GIOStream to handle proxy payload. * - * Return value: (transfer full): a #GIOStream that will replace @connection. This might + * Returns: (transfer full): a #GIOStream that will replace @connection. This might * be the same as @connection, in which case a reference * will be added. * @@ -161,7 +161,7 @@ g_proxy_connect_async (GProxy *proxy, * * See g_proxy_connect(). * - * Return value: (transfer full): a #GIOStream. + * Returns: (transfer full): a #GIOStream. * * Since: 2.26 */ @@ -191,7 +191,7 @@ g_proxy_connect_finish (GProxy *proxy, * #GProxyAddress containing the stringified IP address to * g_proxy_connect() or g_proxy_connect_async(). * - * Return value: %TRUE if hostname resolution is supported. + * Returns: %TRUE if hostname resolution is supported. * * Since: 2.26 */ diff --git a/gio/gproxyresolver.c b/gio/gproxyresolver.c index 7f7e1bc1e..d51dcc523 100644 --- a/gio/gproxyresolver.c +++ b/gio/gproxyresolver.c @@ -53,7 +53,7 @@ g_proxy_resolver_default_init (GProxyResolverInterface *iface) * * Gets the default #GProxyResolver for the system. * - * Return value: (transfer none): the default #GProxyResolver. + * Returns: (transfer none): the default #GProxyResolver. * * Since: 2.26 */ @@ -73,7 +73,7 @@ g_proxy_resolver_get_default (void) * internally; g_proxy_resolver_get_default() will only return a proxy * resolver that returns %TRUE for this method.) * - * Return value: %TRUE if @resolver is supported. + * Returns: %TRUE if @resolver is supported. * * Since: 2.26 */ @@ -112,7 +112,7 @@ g_proxy_resolver_is_supported (GProxyResolver *resolver) * Direct connection should not be attempted unless it is part of the * returned array of proxies. * - * Return value: (transfer full) (array zero-terminated=1): A + * Returns: (transfer full) (array zero-terminated=1): A * NULL-terminated array of proxy URIs. Must be freed * with g_strfreev(). * @@ -174,7 +174,7 @@ g_proxy_resolver_lookup_async (GProxyResolver *resolver, * g_proxy_resolver_lookup_async() is complete. See * g_proxy_resolver_lookup() for more details. * - * Return value: (transfer full) (array zero-terminated=1): A + * Returns: (transfer full) (array zero-terminated=1): A * NULL-terminated array of proxy URIs. Must be freed * with g_strfreev(). * diff --git a/gio/gresolver.c b/gio/gresolver.c index 78d079a55..d971cf440 100644 --- a/gio/gresolver.c +++ b/gio/gresolver.c @@ -192,7 +192,7 @@ static GResolver *default_resolver; * with it. #GResolver may use its reference count as a hint about how * many threads it should allocate for concurrent DNS resolutions. * - * Return value: (transfer full): the default #GResolver. + * Returns: (transfer full): the default #GResolver. * * Since: 2.22 */ @@ -355,7 +355,7 @@ handle_ip_address (const char *hostname, * address, it may be easier to create a #GNetworkAddress and use its * #GSocketConnectable interface. * - * Return value: (element-type GInetAddress) (transfer full): a #GList + * Returns: (element-type GInetAddress) (transfer full): a #GList * of #GInetAddress, or %NULL on error. You * must unref each of the addresses and free the list when you are * done with it. (You can use g_resolver_free_addresses() to do this.) @@ -458,7 +458,7 @@ g_resolver_lookup_by_name_async (GResolver *resolver, * a value from #GResolverError. If the operation was cancelled, * @error will be set to %G_IO_ERROR_CANCELLED. * - * Return value: (element-type GInetAddress) (transfer full): a #GList + * Returns: (element-type GInetAddress) (transfer full): a #GList * of #GInetAddress, or %NULL on error. See g_resolver_lookup_by_name() * for more details. * @@ -527,7 +527,7 @@ g_resolver_free_addresses (GList *addresses) * operation, in which case @error (if non-%NULL) will be set to * %G_IO_ERROR_CANCELLED. * - * Return value: a hostname (either ASCII-only, or in ASCII-encoded + * Returns: a hostname (either ASCII-only, or in ASCII-encoded * form), or %NULL on error. * * Since: 2.22 @@ -588,7 +588,7 @@ g_resolver_lookup_by_address_async (GResolver *resolver, * a value from #GResolverError. If the operation was cancelled, * @error will be set to %G_IO_ERROR_CANCELLED. * - * Return value: a hostname (either ASCII-only, or in ASCII-encoded + * Returns: a hostname (either ASCII-only, or in ASCII-encoded * form), or %NULL on error. * * Since: 2.22 @@ -654,7 +654,7 @@ g_resolver_get_service_rrname (const char *service, * to create a #GNetworkService and use its #GSocketConnectable * interface. * - * Return value: (element-type GSrvTarget) (transfer full): a #GList of #GSrvTarget, + * Returns: (element-type GSrvTarget) (transfer full): a #GList of #GSrvTarget, * or %NULL on error. You must free each of the targets and the list when you are * done with it. (You can use g_resolver_free_targets() to do this.) * @@ -742,7 +742,7 @@ g_resolver_lookup_service_async (GResolver *resolver, * a value from #GResolverError. If the operation was cancelled, * @error will be set to %G_IO_ERROR_CANCELLED. * - * Return value: (element-type GSrvTarget) (transfer full): a #GList of #GSrvTarget, + * Returns: (element-type GSrvTarget) (transfer full): a #GList of #GSrvTarget, * or %NULL on error. See g_resolver_lookup_service() for more details. * * Since: 2.22 @@ -801,7 +801,7 @@ g_resolver_free_targets (GList *targets) * operation, in which case @error (if non-%NULL) will be set to * %G_IO_ERROR_CANCELLED. * - * Return value: (element-type GVariant) (transfer full): a #GList of #GVariant, + * Returns: (element-type GVariant) (transfer full): a #GList of #GVariant, * or %NULL on error. You must free each of the records and the list when you are * done with it. (You can use g_list_free_full() with g_variant_unref() to do this.) * @@ -872,7 +872,7 @@ g_resolver_lookup_records_async (GResolver *resolver, * a value from #GResolverError. If the operation was cancelled, * @error will be set to %G_IO_ERROR_CANCELLED. * - * Return value: (element-type GVariant) (transfer full): a #GList of #GVariant, + * Returns: (element-type GVariant) (transfer full): a #GList of #GVariant, * or %NULL on error. You must free each of the records and the list when you are * done with it. (You can use g_list_free_full() with g_variant_unref() to do this.) * @@ -907,7 +907,7 @@ g_resolver_get_serial (GResolver *resolver) * * Gets the #GResolver Error Quark. * - * Return value: a #GQuark. + * Returns: a #GQuark. * * Since: 2.22 */ diff --git a/gio/gresource.c b/gio/gresource.c index ae18b248f..d9c1699c8 100644 --- a/gio/gresource.c +++ b/gio/gresource.c @@ -134,7 +134,7 @@ G_DEFINE_BOXED_TYPE (GResource, g_resource, g_resource_ref, g_resource_unref) * * Gets the #GResource Error Quark. * - * Return value: a #GQuark + * Returns: a #GQuark * * Since: 2.32 */ @@ -209,7 +209,7 @@ g_resource_new_from_table (GvdbTable *table) * If you want to use this resource in the global resource namespace you need * to register it with g_resources_register(). * - * Return value: (transfer full): a new #GResource, or %NULL on error + * Returns: (transfer full): a new #GResource, or %NULL on error * * Since: 2.32 **/ @@ -244,7 +244,7 @@ g_resource_new_from_data (GBytes *data, * If you want to use this resource in the global resource namespace you need * to register it with g_resources_register(). * - * Return value: (transfer full): a new #GResource, or %NULL on error + * Returns: (transfer full): a new #GResource, or %NULL on error * * Since: 2.32 **/ @@ -1015,7 +1015,7 @@ g_static_resource_fini (GStaticResource *static_resource) * [glib-compile-resources][glib-compile-resources] * and is not typically used by other code. * - * Return value: (transfer none): a #GResource + * Returns: (transfer none): a #GResource * * Since: 2.32 **/ diff --git a/gio/gsocketaddressenumerator.c b/gio/gsocketaddressenumerator.c index 7d645bb6b..51ca4a584 100644 --- a/gio/gsocketaddressenumerator.c +++ b/gio/gsocketaddressenumerator.c @@ -65,7 +65,7 @@ g_socket_address_enumerator_class_init (GSocketAddressEnumeratorClass *enumerato * internal errors (other than @cancellable being triggered) will be * ignored. * - * Return value: (transfer full): a #GSocketAddress (owned by the caller), or %NULL on + * Returns: (transfer full): a #GSocketAddress (owned by the caller), or %NULL on * error (in which case *@error will be set) or if there are no * more addresses. */ @@ -156,7 +156,7 @@ g_socket_address_enumerator_real_next_finish (GSocketAddressEnumerator *enumera * g_socket_address_enumerator_next() for more information about * error handling. * - * Return value: (transfer full): a #GSocketAddress (owned by the caller), or %NULL on + * Returns: (transfer full): a #GSocketAddress (owned by the caller), or %NULL on * error (in which case *@error will be set) or if there are no * more addresses. */ diff --git a/gio/gsocketconnectable.c b/gio/gsocketconnectable.c index 098ce1c11..79901aa98 100644 --- a/gio/gsocketconnectable.c +++ b/gio/gsocketconnectable.c @@ -100,7 +100,7 @@ g_socket_connectable_default_init (GSocketConnectableInterface *iface) * * Creates a #GSocketAddressEnumerator for @connectable. * - * Return value: (transfer full): a new #GSocketAddressEnumerator. + * Returns: (transfer full): a new #GSocketAddressEnumerator. * * Since: 2.22 */ @@ -128,7 +128,7 @@ g_socket_connectable_enumerate (GSocketConnectable *connectable) * g_socket_connectable_proxy_enumerate(), this will fall back to * calling g_socket_connectable_enumerate(). * - * Return value: (transfer full): a new #GSocketAddressEnumerator. + * Returns: (transfer full): a new #GSocketAddressEnumerator. * * Since: 2.26 */ diff --git a/gio/gsrvtarget.c b/gio/gsrvtarget.c index 1d34e5934..232da5a34 100644 --- a/gio/gsrvtarget.c +++ b/gio/gsrvtarget.c @@ -78,7 +78,7 @@ G_DEFINE_BOXED_TYPE (GSrvTarget, g_srv_target, * You should not need to use this; normally #GSrvTargets are * created by #GResolver. * - * Return value: a new #GSrvTarget. + * Returns: a new #GSrvTarget. * * Since: 2.22 */ @@ -104,7 +104,7 @@ g_srv_target_new (const gchar *hostname, * * Copies @target * - * Return value: a copy of @target + * Returns: a copy of @target * * Since: 2.22 */ @@ -139,7 +139,7 @@ g_srv_target_free (GSrvTarget *target) * check if it contains encoded Unicode segments, and use * g_hostname_to_unicode() to convert it if it does.) * - * Return value: @target's hostname + * Returns: @target's hostname * * Since: 2.22 */ @@ -155,7 +155,7 @@ g_srv_target_get_hostname (GSrvTarget *target) * * Gets @target's port * - * Return value: @target's port + * Returns: @target's port * * Since: 2.22 */ @@ -173,7 +173,7 @@ g_srv_target_get_port (GSrvTarget *target) * #GResolver already sorts the targets according to the algorithm in * RFC 2782. * - * Return value: @target's priority + * Returns: @target's priority * * Since: 2.22 */ @@ -191,7 +191,7 @@ g_srv_target_get_priority (GSrvTarget *target) * #GResolver already sorts the targets according to the algorithm in * RFC 2782. * - * Return value: @target's weight + * Returns: @target's weight * * Since: 2.22 */ @@ -225,7 +225,7 @@ compare_target (gconstpointer a, gconstpointer b) * * Sorts @targets in place according to the algorithm in RFC 2782. * - * Return value: (transfer full): the head of the sorted list. + * Returns: (transfer full): the head of the sorted list. * * Since: 2.22 */ diff --git a/gio/gtask.c b/gio/gtask.c index 48d8ff52e..f57080b4c 100644 --- a/gio/gtask.c +++ b/gio/gtask.c @@ -1058,7 +1058,7 @@ g_task_get_return_on_cancel (GTask *task) * * Gets @task's source tag. See g_task_set_source_tag(). * - * Return value: (transfer none): @task's source tag + * Returns: (transfer none): @task's source tag * * Since: 2.36 */ @@ -1662,7 +1662,7 @@ g_task_return_new_error (GTask *task, * g_task_return_pointer() for more discussion of exactly what this * means). * - * Return value: %TRUE if @task has been cancelled, %FALSE if not + * Returns: %TRUE if @task has been cancelled, %FALSE if not * * Since: 2.36 */ @@ -1720,7 +1720,7 @@ g_task_had_error (GTask *task) * source object (or that @source_object is %NULL and @result has no * source object). This can be used in g_return_if_fail() checks. * - * Return value: %TRUE if @result and @source_object are valid, %FALSE + * Returns: %TRUE if @result and @source_object are valid, %FALSE * if not * * Since: 2.36 diff --git a/gio/gtcpwrapperconnection.c b/gio/gtcpwrapperconnection.c index 742abc13a..3bdecf1f7 100644 --- a/gio/gtcpwrapperconnection.c +++ b/gio/gtcpwrapperconnection.c @@ -157,7 +157,7 @@ g_tcp_wrapper_connection_init (GTcpWrapperConnection *connection) * * Wraps @base_io_stream and @socket together as a #GSocketConnection. * - * Return value: the new #GSocketConnection. + * Returns: the new #GSocketConnection. * * Since: 2.28 */ @@ -183,7 +183,7 @@ g_tcp_wrapper_connection_new (GIOStream *base_io_stream, * * Get's @conn's base #GIOStream * - * Return value: (transfer none): @conn's base #GIOStream + * Returns: (transfer none): @conn's base #GIOStream */ GIOStream * g_tcp_wrapper_connection_get_base_io_stream (GTcpWrapperConnection *conn) diff --git a/gio/gtlsbackend.c b/gio/gtlsbackend.c index f83515c2e..aa46e3a3c 100644 --- a/gio/gtlsbackend.c +++ b/gio/gtlsbackend.c @@ -102,7 +102,7 @@ g_tls_backend_get_default (void) * Checks if TLS is supported; if this returns %FALSE for the default * #GTlsBackend, it means no "real" TLS backend is available. * - * Return value: whether or not TLS is supported + * Returns: whether or not TLS is supported * * Since: 2.28 */ @@ -123,7 +123,7 @@ g_tls_backend_supports_tls (GTlsBackend *backend) * * Gets the default #GTlsDatabase used to verify TLS connections. * - * Return value: (transfer full): the default database, which should be + * Returns: (transfer full): the default database, which should be * unreffed when done. * * Since: 2.30 @@ -146,7 +146,7 @@ g_tls_backend_get_default_database (GTlsBackend *backend) * * Gets the #GType of @backend's #GTlsCertificate implementation. * - * Return value: the #GType of @backend's #GTlsCertificate + * Returns: the #GType of @backend's #GTlsCertificate * implementation. * * Since: 2.28 @@ -163,7 +163,7 @@ g_tls_backend_get_certificate_type (GTlsBackend *backend) * * Gets the #GType of @backend's #GTlsClientConnection implementation. * - * Return value: the #GType of @backend's #GTlsClientConnection + * Returns: the #GType of @backend's #GTlsClientConnection * implementation. * * Since: 2.28 @@ -180,7 +180,7 @@ g_tls_backend_get_client_connection_type (GTlsBackend *backend) * * Gets the #GType of @backend's #GTlsServerConnection implementation. * - * Return value: the #GType of @backend's #GTlsServerConnection + * Returns: the #GType of @backend's #GTlsServerConnection * implementation. * * Since: 2.28 @@ -197,7 +197,7 @@ g_tls_backend_get_server_connection_type (GTlsBackend *backend) * * Gets the #GType of @backend's #GTlsFileDatabase implementation. * - * Return value: the #GType of backend's #GTlsFileDatabase implementation. + * Returns: the #GType of backend's #GTlsFileDatabase implementation. * * Since: 2.30 */ diff --git a/gio/gtlscertificate.c b/gio/gtlscertificate.c index af555cdf0..a532fe576 100644 --- a/gio/gtlscertificate.c +++ b/gio/gtlscertificate.c @@ -320,7 +320,7 @@ parse_next_pem_certificate (const gchar **data, * If @data includes multiple certificates, only the first one will be * parsed. * - * Return value: the new certificate, or %NULL if @data is invalid + * Returns: the new certificate, or %NULL if @data is invalid * * Since: 2.28 */ @@ -368,7 +368,7 @@ g_tls_certificate_new_from_pem (const gchar *data, * set @error. Otherwise, this behaves like * g_tls_certificate_new_from_pem(). * - * Return value: the new certificate, or %NULL on error + * Returns: the new certificate, or %NULL on error * * Since: 2.28 */ @@ -399,7 +399,7 @@ g_tls_certificate_new_from_file (const gchar *file, * function will return %NULL and set @error. Otherwise, this behaves * like g_tls_certificate_new_from_pem(). * - * Return value: the new certificate, or %NULL on error + * Returns: the new certificate, or %NULL on error * * Since: 2.28 */ @@ -452,7 +452,7 @@ g_tls_certificate_new_from_files (const gchar *cert_file, * PEM-encoded certificates, this will return an empty list and not * set @error. * - * Return value: (element-type Gio.TlsCertificate) (transfer full): a + * Returns: (element-type Gio.TlsCertificate) (transfer full): a * #GList containing #GTlsCertificate objects. You must free the list * and its contents when you are done with it. * @@ -503,7 +503,7 @@ g_tls_certificate_list_new_from_file (const gchar *file, * * Gets the #GTlsCertificate representing @cert's issuer, if known * - * Return value: (transfer none): The certificate of @cert's issuer, + * Returns: (transfer none): The certificate of @cert's issuer, * or %NULL if @cert is self-signed or signed with an unknown * certificate. * @@ -547,7 +547,7 @@ g_tls_certificate_get_issuer (GTlsCertificate *cert) * (All other #GTlsCertificateFlags values will always be set or unset * as appropriate.) * - * Return value: the appropriate #GTlsCertificateFlags + * Returns: the appropriate #GTlsCertificateFlags * * Since: 2.28 */ @@ -570,7 +570,7 @@ g_tls_certificate_verify (GTlsCertificate *cert, * their #GTlsCertificate:issuer, #GTlsCertificate:private-key, or * #GTlsCertificate:private-key-pem properties differ. * - * Return value: whether the same or not + * Returns: whether the same or not * * Since: 2.34 */ diff --git a/gio/gtlsclientconnection.c b/gio/gtlsclientconnection.c index 80ede3412..410dda9a6 100644 --- a/gio/gtlsclientconnection.c +++ b/gio/gtlsclientconnection.c @@ -151,7 +151,7 @@ g_tls_client_connection_default_init (GTlsClientConnectionInterface *iface) * must have pollable input and output streams) which is assumed to * communicate with the server identified by @server_identity. * - * Return value: (transfer full) (type GTlsClientConnection): the new + * Returns: (transfer full) (type GTlsClientConnection): the new * #GTlsClientConnection, or %NULL on error * * Since: 2.28 @@ -179,7 +179,7 @@ g_tls_client_connection_new (GIOStream *base_io_stream, * * Gets @conn's validation flags * - * Return value: the validation flags + * Returns: the validation flags * * Since: 2.28 */ @@ -220,7 +220,7 @@ g_tls_client_connection_set_validation_flags (GTlsClientConnection *conn, * * Gets @conn's expected server identity * - * Return value: (transfer none): a #GSocketConnectable describing the + * Returns: (transfer none): a #GSocketConnectable describing the * expected server identity, or %NULL if the expected identity is not * known. * @@ -268,7 +268,7 @@ g_tls_client_connection_set_server_identity (GTlsClientConnection *conn, * highest-supported version of TLS; see * g_tls_client_connection_set_use_ssl3(). * - * Return value: whether @conn will use SSL 3.0 + * Returns: whether @conn will use SSL 3.0 * * Since: 2.28 */ @@ -317,7 +317,7 @@ g_tls_client_connection_set_use_ssl3 (GTlsClientConnection *conn, * Each item in the list is a #GByteArray which contains the complete * subject DN of the certificate authority. * - * Return value: (element-type GByteArray) (transfer full): the list of + * Returns: (element-type GByteArray) (transfer full): the list of * CA DNs. You should unref each element with g_byte_array_unref() and then * the free the list with g_list_free(). * diff --git a/gio/gtlsconnection.c b/gio/gtlsconnection.c index 5c8c3df18..d614c05ba 100644 --- a/gio/gtlsconnection.c +++ b/gio/gtlsconnection.c @@ -285,7 +285,7 @@ g_tls_connection_class_init (GTlsConnectionClass *klass) * need to worry about this, and can simply block in the signal * handler until the UI thread returns an answer. * - * Return value: %TRUE to accept @peer_cert (which will also + * Returns: %TRUE to accept @peer_cert (which will also * immediately end the signal emission). %FALSE to allow the signal * emission to continue, which will cause the handshake to fail if * no one else overrides it. @@ -360,7 +360,7 @@ g_tls_connection_set_use_system_certdb (GTlsConnection *conn, * Gets whether @conn uses the system certificate database to verify * peer certificates. See g_tls_connection_set_use_system_certdb(). * - * Return value: whether @conn uses the system certificate database + * Returns: whether @conn uses the system certificate database * * Deprecated: 2.30: Use g_tls_connection_get_database() instead */ @@ -412,7 +412,7 @@ g_tls_connection_set_database (GTlsConnection *conn, * Gets the certificate database that @conn uses to verify * peer certificates. See g_tls_connection_set_database(). * - * Return value: (transfer none): the certificate database that @conn uses or %NULL + * Returns: (transfer none): the certificate database that @conn uses or %NULL * * Since: 2.30 */ @@ -474,7 +474,7 @@ g_tls_connection_set_certificate (GTlsConnection *conn, * Gets @conn's certificate, as set by * g_tls_connection_set_certificate(). * - * Return value: (transfer none): @conn's certificate, or %NULL + * Returns: (transfer none): @conn's certificate, or %NULL * * Since: 2.28 */ @@ -550,7 +550,7 @@ g_tls_connection_get_interaction (GTlsConnection *conn) * (It is not set during the emission of * #GTlsConnection::accept-certificate.) * - * Return value: (transfer none): @conn's peer's certificate, or %NULL + * Returns: (transfer none): @conn's peer's certificate, or %NULL * * Since: 2.28 */ @@ -576,7 +576,7 @@ g_tls_connection_get_peer_certificate (GTlsConnection *conn) * certificate, after the handshake has completed. (It is not set * during the emission of #GTlsConnection::accept-certificate.) * - * Return value: @conn's peer's certificate errors + * Returns: @conn's peer's certificate errors * * Since: 2.28 */ @@ -644,7 +644,7 @@ g_tls_connection_set_require_close_notify (GTlsConnection *conn, * when the connection is closed. See * g_tls_connection_set_require_close_notify() for details. * - * Return value: %TRUE if @conn requires a proper TLS close + * Returns: %TRUE if @conn requires a proper TLS close * notification. * * Since: 2.28 @@ -708,7 +708,7 @@ g_tls_connection_set_rehandshake_mode (GTlsConnection *conn, * Gets @conn rehandshaking mode. See * g_tls_connection_set_rehandshake_mode() for details. * - * Return value: @conn's rehandshaking mode + * Returns: @conn's rehandshaking mode * * Since: 2.28 */ @@ -754,7 +754,7 @@ g_tls_connection_get_rehandshake_mode (GTlsConnection *conn) * #GTlsConnection::accept_certificate may be emitted during the * handshake. * - * Return value: success or failure + * Returns: success or failure * * Since: 2.28 */ @@ -804,7 +804,7 @@ g_tls_connection_handshake_async (GTlsConnection *conn, * Finish an asynchronous TLS handshake operation. See * g_tls_connection_handshake() for more information. * - * Return value: %TRUE on success, %FALSE on failure, in which + * Returns: %TRUE on success, %FALSE on failure, in which * case @error will be set. * * Since: 2.28 @@ -824,7 +824,7 @@ g_tls_connection_handshake_finish (GTlsConnection *conn, * * Gets the TLS error quark. * - * Return value: a #GQuark. + * Returns: a #GQuark. * * Since: 2.28 */ @@ -839,7 +839,7 @@ G_DEFINE_QUARK (g-tls-error-quark, g_tls_error) * Used by #GTlsConnection implementations to emit the * #GTlsConnection::accept-certificate signal. * - * Return value: %TRUE if one of the signal handlers has returned + * Returns: %TRUE if one of the signal handlers has returned * %TRUE to accept @peer_cert * * Since: 2.28 diff --git a/gio/gtlsdatabase.c b/gio/gtlsdatabase.c index 948558737..909938725 100644 --- a/gio/gtlsdatabase.c +++ b/gio/gtlsdatabase.c @@ -437,7 +437,7 @@ g_tls_database_class_init (GTlsDatabaseClass *klass) * This function can block, use g_tls_database_verify_chain_async() to perform * the verification operation asynchronously. * - * Return value: the appropriate #GTlsCertificateFlags which represents the + * Returns: the appropriate #GTlsCertificateFlags which represents the * result of verification. * * Since: 2.30 @@ -534,7 +534,7 @@ g_tls_database_verify_chain_async (GTlsDatabase *self, * * Finish an asynchronous verify chain operation. See * g_tls_database_verify_chain() for more information. * - * Return value: the appropriate #GTlsCertificateFlags which represents the + * Returns: the appropriate #GTlsCertificateFlags which represents the * result of verification. * * Since: 2.30 @@ -604,7 +604,7 @@ g_tls_database_create_certificate_handle (GTlsDatabase *self, * This function can block, use g_tls_database_lookup_certificate_for_handle_async() to perform * the lookup operation asynchronously. * - * Return value: (transfer full) (allow-none): a newly allocated + * Returns: (transfer full) (allow-none): a newly allocated * #GTlsCertificate, or %NULL. Use g_object_unref() to release the certificate. * * Since: 2.30 @@ -682,7 +682,7 @@ g_tls_database_lookup_certificate_for_handle_async (GTlsDatabase *sel * If the handle is no longer valid, or does not point to a certificate in * this database, then %NULL will be returned. * - * Return value: (transfer full): a newly allocated #GTlsCertificate object. + * Returns: (transfer full): a newly allocated #GTlsCertificate object. * Use g_object_unref() to release the certificate. * * Since: 2.30 @@ -719,7 +719,7 @@ g_tls_database_lookup_certificate_for_handle_finish (GTlsDatabase *se * This function can block, use g_tls_database_lookup_certificate_issuer_async() to perform * the lookup operation asynchronously. * - * Return value: (transfer full): a newly allocated issuer #GTlsCertificate, + * Returns: (transfer full): a newly allocated issuer #GTlsCertificate, * or %NULL. Use g_object_unref() to release the certificate. * * Since: 2.30 @@ -794,7 +794,7 @@ g_tls_database_lookup_certificate_issuer_async (GTlsDatabase *self, * Finish an asynchronous lookup issuer operation. See * g_tls_database_lookup_certificate_issuer() for more information. * - * Return value: (transfer full): a newly allocated issuer #GTlsCertificate, + * Returns: (transfer full): a newly allocated issuer #GTlsCertificate, * or %NULL. Use g_object_unref() to release the certificate. * * Since: 2.30 @@ -827,7 +827,7 @@ g_tls_database_lookup_certificate_issuer_finish (GTlsDatabase *self, * This function can block, use g_tls_database_lookup_certificates_issued_by_async() to perform * the lookup operation asynchronously. * - * Return value: (transfer full) (element-type GTlsCertificate): a newly allocated list of #GTlsCertificate + * Returns: (transfer full) (element-type GTlsCertificate): a newly allocated list of #GTlsCertificate * objects. Use g_object_unref() on each certificate, and g_list_free() on the release the list. * * Since: 2.30 @@ -906,7 +906,7 @@ g_tls_database_lookup_certificates_issued_by_async (GTlsDatabase *self * Finish an asynchronous lookup of certificates. See * g_tls_database_lookup_certificates_issued_by() for more information. * - * Return value: (transfer full) (element-type GTlsCertificate): a newly allocated list of #GTlsCertificate + * Returns: (transfer full) (element-type GTlsCertificate): a newly allocated list of #GTlsCertificate * objects. Use g_object_unref() on each certificate, and g_list_free() on the release the list. * * Since: 2.30 diff --git a/gio/gtlsfiledatabase.c b/gio/gtlsfiledatabase.c index e68846ed2..dd341bca5 100644 --- a/gio/gtlsfiledatabase.c +++ b/gio/gtlsfiledatabase.c @@ -82,7 +82,7 @@ g_tls_file_database_default_init (GTlsFileDatabaseInterface *iface) * * The certificates in @anchors must be PEM encoded. * - * Return value: (transfer full) (type GTlsFileDatabase): the new + * Returns: (transfer full) (type GTlsFileDatabase): the new * #GTlsFileDatabase, or %NULL on error * * Since: 2.30 diff --git a/gio/gtlspassword.c b/gio/gtlspassword.c index a8cbe1676..57e60ac75 100644 --- a/gio/gtlspassword.c +++ b/gio/gtlspassword.c @@ -327,7 +327,7 @@ g_tls_password_set_value_full (GTlsPassword *password, * * Get flags about the password. * - * Return value: The flags about the password. + * Returns: The flags about the password. * * Since: 2.30 */ @@ -364,7 +364,7 @@ g_tls_password_set_flags (GTlsPassword *password, * * Get a description string about what the password will be used for. * - * Return value: The description of the password. + * Returns: The description of the password. * * Since: 2.30 */ @@ -407,7 +407,7 @@ g_tls_password_set_description (GTlsPassword *password, * representation of the password flags returned from * g_tls_password_get_flags(). * - * Return value: The warning. + * Returns: The warning. * * Since: 2.30 */ diff --git a/gio/gtlsserverconnection.c b/gio/gtlsserverconnection.c index 6c4640762..4c2f48682 100644 --- a/gio/gtlsserverconnection.c +++ b/gio/gtlsserverconnection.c @@ -71,7 +71,7 @@ g_tls_server_connection_default_init (GTlsServerConnectionInterface *iface) * Creates a new #GTlsServerConnection wrapping @base_io_stream (which * must have pollable input and output streams). * - * Return value: (transfer full) (type GTlsServerConnection): the new + * Returns: (transfer full) (type GTlsServerConnection): the new * #GTlsServerConnection, or %NULL on error * * Since: 2.28 diff --git a/gio/gunixinputstream.c b/gio/gunixinputstream.c index 1d7d88d30..24700ece8 100644 --- a/gio/gunixinputstream.c +++ b/gio/gunixinputstream.c @@ -301,7 +301,7 @@ g_unix_input_stream_set_close_fd (GUnixInputStream *stream, * Returns whether the file descriptor of @stream will be * closed when the stream is closed. * - * Return value: %TRUE if the file descriptor is closed when done + * Returns: %TRUE if the file descriptor is closed when done * * Since: 2.20 */ @@ -319,7 +319,7 @@ g_unix_input_stream_get_close_fd (GUnixInputStream *stream) * * Return the UNIX file descriptor that the stream reads from. * - * Return value: The file descriptor of @stream + * Returns: The file descriptor of @stream * * Since: 2.20 */ diff --git a/gio/gunixoutputstream.c b/gio/gunixoutputstream.c index 353be07d0..8aa7292b5 100644 --- a/gio/gunixoutputstream.c +++ b/gio/gunixoutputstream.c @@ -286,7 +286,7 @@ g_unix_output_stream_set_close_fd (GUnixOutputStream *stream, * Returns whether the file descriptor of @stream will be * closed when the stream is closed. * - * Return value: %TRUE if the file descriptor is closed when done + * Returns: %TRUE if the file descriptor is closed when done * * Since: 2.20 */ @@ -304,7 +304,7 @@ g_unix_output_stream_get_close_fd (GUnixOutputStream *stream) * * Return the UNIX file descriptor that the stream writes to. * - * Return value: The file descriptor of @stream + * Returns: The file descriptor of @stream * * Since: 2.20 */ diff --git a/gio/gwin32inputstream.c b/gio/gwin32inputstream.c index 685ecb0dd..179e13991 100644 --- a/gio/gwin32inputstream.c +++ b/gio/gwin32inputstream.c @@ -240,7 +240,7 @@ g_win32_input_stream_set_close_handle (GWin32InputStream *stream, * Returns whether the handle of @stream will be * closed when the stream is closed. * - * Return value: %TRUE if the handle is closed when done + * Returns: %TRUE if the handle is closed when done * * Since: 2.26 */ @@ -258,7 +258,7 @@ g_win32_input_stream_get_close_handle (GWin32InputStream *stream) * * Return the Windows file handle that the stream reads from. * - * Return value: The file handle of @stream + * Returns: The file handle of @stream * * Since: 2.26 */ diff --git a/gio/gwin32outputstream.c b/gio/gwin32outputstream.c index 13476c02a..f69212b10 100644 --- a/gio/gwin32outputstream.c +++ b/gio/gwin32outputstream.c @@ -241,7 +241,7 @@ g_win32_output_stream_set_close_handle (GWin32OutputStream *stream, * Returns whether the handle of @stream will be closed when the * stream is closed. * - * Return value: %TRUE if the handle is closed when done + * Returns: %TRUE if the handle is closed when done * * Since: 2.26 */ @@ -259,7 +259,7 @@ g_win32_output_stream_get_close_handle (GWin32OutputStream *stream) * * Return the Windows handle that the stream writes to. * - * Return value: The handle descriptor of @stream + * Returns: The handle descriptor of @stream * * Since: 2.26 */ diff --git a/gio/gwin32volumemonitor.c b/gio/gwin32volumemonitor.c index d3932fc12..5e9369981 100644 --- a/gio/gwin32volumemonitor.c +++ b/gio/gwin32volumemonitor.c @@ -55,7 +55,7 @@ G_DEFINE_TYPE_WITH_CODE (GWin32VolumeMonitor, g_win32_volume_monitor, G_TYPE_NAT * HKLM or HKCU. If neither key exists the result of * GetLogicalDrives() is returned. * - * Return value: bitmask with same meaning as returned by GetLogicalDrives() + * Returns: bitmask with same meaning as returned by GetLogicalDrives() */ static guint32 get_viewable_logical_drives (void) diff --git a/gio/inotify/inotify-helper.c b/gio/inotify/inotify-helper.c index 9f0fcf618..abf66c869 100644 --- a/gio/inotify/inotify-helper.c +++ b/gio/inotify/inotify-helper.c @@ -64,7 +64,7 @@ static GFileMonitorEvent ih_mask_to_EventFlags (guint32 mask); * Initializes the inotify backend. This must be called before * any other functions in this module. * - * Return value: #TRUE if initialization succeeded, #FALSE otherwise + * Returns: #TRUE if initialization succeeded, #FALSE otherwise */ gboolean _ih_startup (void) diff --git a/glib/deprecated/gcompletion.c b/glib/deprecated/gcompletion.c index cd467467a..4cfa629c6 100644 --- a/glib/deprecated/gcompletion.c +++ b/glib/deprecated/gcompletion.c @@ -292,7 +292,7 @@ completion_check_cache (GCompletion* cmp, * You should use this function instead of g_completion_complete() if your * items are UTF-8 strings. * - * Return value: (element-type utf8) (transfer none): the list of items whose strings begin with @prefix. This should + * Returns: (element-type utf8) (transfer none): the list of items whose strings begin with @prefix. This should * not be changed. * * Since: 2.4 diff --git a/glib/gasyncqueue.c b/glib/gasyncqueue.c index 42766ad55..08bf126fc 100644 --- a/glib/gasyncqueue.c +++ b/glib/gasyncqueue.c @@ -113,7 +113,7 @@ typedef struct * * Creates a new asynchronous queue. * - * Return value: a new #GAsyncQueue. Free with g_async_queue_unref() + * Returns: a new #GAsyncQueue. Free with g_async_queue_unref() */ GAsyncQueue * g_async_queue_new (void) @@ -129,7 +129,7 @@ g_async_queue_new (void) * function that is used to free any remaining queue items when * the queue is destroyed after the final unref. * - * Return value: a new #GAsyncQueue. Free with g_async_queue_unref() + * Returns: a new #GAsyncQueue. Free with g_async_queue_unref() * * Since: 2.16 */ @@ -440,7 +440,7 @@ g_async_queue_pop_intern_unlocked (GAsyncQueue *queue, * Pops data from the @queue. If @queue is empty, this function * blocks until data becomes available. * - * Return value: data from the queue + * Returns: data from the queue */ gpointer g_async_queue_pop (GAsyncQueue *queue) @@ -465,7 +465,7 @@ g_async_queue_pop (GAsyncQueue *queue) * * This function must be called while holding the @queue's lock. * - * Return value: data from the queue. + * Returns: data from the queue. */ gpointer g_async_queue_pop_unlocked (GAsyncQueue *queue) @@ -482,7 +482,7 @@ g_async_queue_pop_unlocked (GAsyncQueue *queue) * Tries to pop data from the @queue. If no data is available, * %NULL is returned. * - * Return value: data from the queue or %NULL, when no data is + * Returns: data from the queue or %NULL, when no data is * available immediately. */ gpointer @@ -508,7 +508,7 @@ g_async_queue_try_pop (GAsyncQueue *queue) * * This function must be called while holding the @queue's lock. * - * Return value: data from the queue or %NULL, when no data is + * Returns: data from the queue or %NULL, when no data is * available immediately. */ gpointer @@ -529,7 +529,7 @@ g_async_queue_try_pop_unlocked (GAsyncQueue *queue) * * If no data is received before the timeout, %NULL is returned. * - * Return value: data from the queue or %NULL, when no data is + * Returns: data from the queue or %NULL, when no data is * received before the timeout. */ gpointer @@ -558,7 +558,7 @@ g_async_queue_timeout_pop (GAsyncQueue *queue, * * This function must be called while holding the @queue's lock. * - * Return value: data from the queue or %NULL, when no data is + * Returns: data from the queue or %NULL, when no data is * received before the timeout. */ gpointer @@ -583,7 +583,7 @@ g_async_queue_timeout_pop_unlocked (GAsyncQueue *queue, * To easily calculate @end_time, a combination of g_get_current_time() * and g_time_val_add() can be used. * - * Return value: data from the queue or %NULL, when no data is + * Returns: data from the queue or %NULL, when no data is * received before @end_time. * * Deprecated: use g_async_queue_timeout_pop(). @@ -628,7 +628,7 @@ g_async_queue_timed_pop (GAsyncQueue *queue, * * This function must be called while holding the @queue's lock. * - * Return value: data from the queue or %NULL, when no data is + * Returns: data from the queue or %NULL, when no data is * received before @end_time. * * Deprecated: use g_async_queue_timeout_pop_unlocked(). @@ -666,7 +666,7 @@ g_async_queue_timed_pop_unlocked (GAsyncQueue *queue, * in the queue and n threads waiting. This can happen due to locking * of the queue or due to scheduling. * - * Return value: the length of the @queue + * Returns: the length of the @queue */ gint g_async_queue_length (GAsyncQueue *queue) @@ -697,7 +697,7 @@ g_async_queue_length (GAsyncQueue *queue) * * This function must be called while holding the @queue's lock. * - * Return value: the length of the @queue. + * Returns: the length of the @queue. */ gint g_async_queue_length_unlocked (GAsyncQueue *queue) diff --git a/glib/gbase64.c b/glib/gbase64.c index 36bec581e..a6cbea459 100644 --- a/glib/gbase64.c +++ b/glib/gbase64.c @@ -85,7 +85,7 @@ static const char base64_alphabet[] = * `CR LF` sequences, so the result cannot be passed directly to SMTP * or certain other protocols. * - * Return value: The number of bytes of output that was written + * Returns: The number of bytes of output that was written * * Since: 2.12 */ @@ -192,7 +192,7 @@ g_base64_encode_step (const guchar *in, * be written to it. It will need up to 4 bytes, or up to 5 bytes if * line-breaking is enabled. * - * Return value: The number of bytes of output that was written + * Returns: The number of bytes of output that was written * * Since: 2.12 */ @@ -244,7 +244,7 @@ g_base64_encode_close (gboolean break_lines, * Encode a sequence of binary data into its Base-64 stringified * representation. * - * Return value: (transfer full): a newly allocated, zero-terminated Base-64 + * Returns: (transfer full): a newly allocated, zero-terminated Base-64 * encoded string representing @data. The returned string must * be freed with g_free(). * @@ -311,7 +311,7 @@ static const unsigned char mime_base64_rank[256] = { * at least: (@len / 4) * 3 + 3 bytes (+ 3 may be needed in case of non-zero * state). * - * Return value: The number of bytes of output that was written + * Returns: The number of bytes of output that was written * * Since: 2.12 **/ @@ -393,7 +393,7 @@ g_base64_decode_step (const gchar *in, * that the returned binary data is not necessarily zero-terminated, * so it should not be used as a character string. * - * Return value: (transfer full) (array length=out_len) (element-type guint8): + * Returns: (transfer full) (array length=out_len) (element-type guint8): * newly allocated buffer containing the binary data * that @text represents. The returned buffer must * be freed with g_free(). @@ -432,7 +432,7 @@ g_base64_decode (const gchar *text, * Decode a sequence of Base-64 encoded text into binary data * by overwriting the input data. * - * Return value: (transfer none): The binary data that @text responds. This pointer + * Returns: (transfer none): The binary data that @text responds. This pointer * is the same as the input @text. * * Since: 2.20 diff --git a/glib/gbookmarkfile.c b/glib/gbookmarkfile.c index 9f94d7102..8b8b50a46 100644 --- a/glib/gbookmarkfile.c +++ b/glib/gbookmarkfile.c @@ -1575,7 +1575,7 @@ G_DEFINE_QUARK (g-bookmark-file-error-quark, g_bookmark_file_error) * or g_bookmark_file_load_from_data_dirs() to read an existing bookmark * file. * - * Return value: an empty #GBookmarkFile + * Returns: an empty #GBookmarkFile * * Since: 2.12 */ @@ -1621,7 +1621,7 @@ g_bookmark_file_free (GBookmarkFile *bookmark) * structure. If the object cannot be created then @error is set to a * #GBookmarkFileError. * - * Return value: %TRUE if a desktop bookmark could be loaded. + * Returns: %TRUE if a desktop bookmark could be loaded. * * Since: 2.12 */ @@ -1664,7 +1664,7 @@ g_bookmark_file_load_from_data (GBookmarkFile *bookmark, * If the file could not be loaded then @error is set to either a #GFileError * or #GBookmarkFileError. * - * Return value: %TRUE if a desktop bookmark file could be loaded + * Returns: %TRUE if a desktop bookmark file could be loaded * * Since: 2.12 */ @@ -1793,7 +1793,7 @@ find_file_in_data_dirs (const gchar *file, * @full_path. If the file could not be loaded then an %error is * set to either a #GFileError or #GBookmarkFileError. * - * Return value: %TRUE if a key file could be loaded, %FALSE otherwise + * Returns: %TRUE if a key file could be loaded, %FALSE otherwise * * Since: 2.12 */ @@ -1869,7 +1869,7 @@ g_bookmark_file_load_from_data_dirs (GBookmarkFile *bookmark, * * This function outputs @bookmark as a string. * - * Return value: a newly allocated string holding + * Returns: a newly allocated string holding * the contents of the #GBookmarkFile * * Since: 2.12 @@ -1904,7 +1904,7 @@ g_bookmark_file_to_data (GBookmarkFile *bookmark, * This function outputs @bookmark into a file. The write process is * guaranteed to be atomic by using g_file_set_contents() internally. * - * Return value: %TRUE if the file was successfully written. + * Returns: %TRUE if the file was successfully written. * * Since: 2.12 */ @@ -1997,7 +1997,7 @@ g_bookmark_file_add_item (GBookmarkFile *bookmark, * * Removes the bookmark for @uri from the bookmark file @bookmark. * - * Return value: %TRUE if the bookmark was removed successfully. + * Returns: %TRUE if the bookmark was removed successfully. * * Since: 2.12 */ @@ -2037,7 +2037,7 @@ g_bookmark_file_remove_item (GBookmarkFile *bookmark, * * Looks whether the desktop bookmark has an item with its URI set to @uri. * - * Return value: %TRUE if @uri is inside @bookmark, %FALSE otherwise + * Returns: %TRUE if @uri is inside @bookmark, %FALSE otherwise * * Since: 2.12 */ @@ -2060,7 +2060,7 @@ g_bookmark_file_has_item (GBookmarkFile *bookmark, * The array of returned URIs will be %NULL-terminated, so @length may * optionally be %NULL. * - * Return value: (array length=length) (transfer full): a newly allocated %NULL-terminated array of strings. + * Returns: (array length=length) (transfer full): a newly allocated %NULL-terminated array of strings. * Use g_strfreev() to free it. * * Since: 2.12 @@ -2153,7 +2153,7 @@ g_bookmark_file_set_title (GBookmarkFile *bookmark, * In the event the URI cannot be found, %NULL is returned and * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. * - * Return value: a newly allocated string or %NULL if the specified + * Returns: a newly allocated string or %NULL if the specified * URI cannot be found. * * Since: 2.12 @@ -2238,7 +2238,7 @@ g_bookmark_file_set_description (GBookmarkFile *bookmark, * In the event the URI cannot be found, %NULL is returned and * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. * - * Return value: a newly allocated string or %NULL if the specified + * Returns: a newly allocated string or %NULL if the specified * URI cannot be found. * * Since: 2.12 @@ -2320,7 +2320,7 @@ g_bookmark_file_set_mime_type (GBookmarkFile *bookmark, * event that the MIME type cannot be found, %NULL is returned and * @error is set to #G_BOOKMARK_FILE_ERROR_INVALID_VALUE. * - * Return value: a newly allocated string or %NULL if the specified + * Returns: a newly allocated string or %NULL if the specified * URI cannot be found. * * Since: 2.12 @@ -2406,7 +2406,7 @@ g_bookmark_file_set_is_private (GBookmarkFile *bookmark, * event that the private flag cannot be found, %FALSE is returned and * @error is set to #G_BOOKMARK_FILE_ERROR_INVALID_VALUE. * - * Return value: %TRUE if the private flag is set, %FALSE otherwise. + * Returns: %TRUE if the private flag is set, %FALSE otherwise. * * Since: 2.12 */ @@ -2489,7 +2489,7 @@ g_bookmark_file_set_added (GBookmarkFile *bookmark, * In the event the URI cannot be found, -1 is returned and * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. * - * Return value: a timestamp + * Returns: a timestamp * * Since: 2.12 */ @@ -2567,7 +2567,7 @@ g_bookmark_file_set_modified (GBookmarkFile *bookmark, * In the event the URI cannot be found, -1 is returned and * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. * - * Return value: a timestamp + * Returns: a timestamp * * Since: 2.12 */ @@ -2646,7 +2646,7 @@ g_bookmark_file_set_visited (GBookmarkFile *bookmark, * In the event the URI cannot be found, -1 is returned and * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. * - * Return value: a timestamp. + * Returns: a timestamp. * * Since: 2.12 */ @@ -2686,7 +2686,7 @@ g_bookmark_file_get_visited (GBookmarkFile *bookmark, * In the event the URI cannot be found, %FALSE is returned and * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. * - * Return value: %TRUE if @group was found. + * Returns: %TRUE if @group was found. * * Since: 2.12 */ @@ -2783,7 +2783,7 @@ g_bookmark_file_add_group (GBookmarkFile *bookmark, * In the event no group was defined, %FALSE is returned and * @error is set to #G_BOOKMARK_FILE_ERROR_INVALID_VALUE. * - * Return value: %TRUE if @group was successfully removed. + * Returns: %TRUE if @group was successfully removed. * * Since: 2.12 */ @@ -2900,7 +2900,7 @@ g_bookmark_file_set_groups (GBookmarkFile *bookmark, * The returned array is %NULL terminated, so @length may optionally * be %NULL. * - * Return value: (array length=length) (transfer full): a newly allocated %NULL-terminated array of group names. + * Returns: (array length=length) (transfer full): a newly allocated %NULL-terminated array of group names. * Use g_strfreev() to free it. * * Since: 2.12 @@ -3046,7 +3046,7 @@ g_bookmark_file_add_application (GBookmarkFile *bookmark, * a bookmark for @uri, %FALSE is returned and error is set to * #G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED. * - * Return value: %TRUE if the application was successfully removed. + * Returns: %TRUE if the application was successfully removed. * * Since: 2.12 */ @@ -3093,7 +3093,7 @@ g_bookmark_file_remove_application (GBookmarkFile *bookmark, * In the event the URI cannot be found, %FALSE is returned and * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. * - * Return value: %TRUE if the application @name was found + * Returns: %TRUE if the application @name was found * * Since: 2.12 */ @@ -3161,7 +3161,7 @@ g_bookmark_file_has_application (GBookmarkFile *bookmark, * #G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED. Otherwise, if no bookmark * for @uri is found, one is created. * - * Return value: %TRUE if the application's meta-data was successfully + * Returns: %TRUE if the application's meta-data was successfully * changed. * * Since: 2.12 @@ -3333,7 +3333,7 @@ expand_exec_line (const gchar *exec_fmt, * the command line fails, an error of the #G_SHELL_ERROR domain is * set and %FALSE is returned. * - * Return value: %TRUE on success. + * Returns: %TRUE on success. * * Since: 2.12 */ @@ -3423,7 +3423,7 @@ g_bookmark_file_get_app_info (GBookmarkFile *bookmark, * In the event the URI cannot be found, %NULL is returned and * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. * - * Return value: (array length=length) (transfer full): a newly allocated %NULL-terminated array of strings. + * Returns: (array length=length) (transfer full): a newly allocated %NULL-terminated array of strings. * Use g_strfreev() to free it. * * Since: 2.12 @@ -3490,7 +3490,7 @@ g_bookmark_file_get_applications (GBookmarkFile *bookmark, * * Gets the number of bookmarks inside @bookmark. * - * Return value: the number of bookmarks + * Returns: the number of bookmarks * * Since: 2.12 */ @@ -3516,7 +3516,7 @@ g_bookmark_file_get_size (GBookmarkFile *bookmark) * In the event the URI cannot be found, %FALSE is returned and * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. * - * Return value: %TRUE if the URI was successfully changed + * Returns: %TRUE if the URI was successfully changed * * Since: 2.12 */ @@ -3630,7 +3630,7 @@ g_bookmark_file_set_icon (GBookmarkFile *bookmark, * In the event the URI cannot be found, %FALSE is returned and * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. * - * Return value: %TRUE if the icon for the bookmark for the URI was found. + * Returns: %TRUE if the icon for the bookmark for the URI was found. * You should free the returned strings. * * Since: 2.12 diff --git a/glib/gcharset.c b/glib/gcharset.c index c14b8fe0f..b1cc465e7 100644 --- a/glib/gcharset.c +++ b/glib/gcharset.c @@ -171,7 +171,7 @@ charset_cache_free (gpointer data) * The string returned in @charset is not allocated, and should not be * freed. * - * Return value: %TRUE if the returned charset is UTF-8 + * Returns: %TRUE if the returned charset is UTF-8 */ gboolean g_get_charset (const char **charset) @@ -212,7 +212,7 @@ g_get_charset (const char **charset) * * Gets the character set for the current locale. * - * Return value: a newly allocated string containing the name + * Returns: a newly allocated string containing the name * of the character set. This string must be freed with g_free(). */ gchar * @@ -542,7 +542,7 @@ language_names_cache_free (gpointer data) * `LC_MESSAGES` and `LANG` to find the list of locales specified by the * user. * - * Return value: (array zero-terminated=1) (transfer none): a %NULL-terminated array of strings owned by GLib + * Returns: (array zero-terminated=1) (transfer none): a %NULL-terminated array of strings owned by GLib * that must not be modified or freed. * * Since: 2.6 diff --git a/glib/gchecksum.c b/glib/gchecksum.c index d8f2e15b8..d61ff5137 100644 --- a/glib/gchecksum.c +++ b/glib/gchecksum.c @@ -1372,7 +1372,7 @@ sha512_sum_digest (Sha512sum *sha512, * * Gets the length in bytes of digests of type @checksum_type * - * Return value: the checksum length, or -1 if @checksum_type is + * Returns: the checksum length, or -1 if @checksum_type is * not supported. * * Since: 2.16 @@ -1422,7 +1422,7 @@ g_checksum_type_get_length (GChecksumType checksum_type) * will be closed and it won't be possible to call g_checksum_update() * on it anymore. * - * Return value: (transfer full): the newly created #GChecksum, or %NULL. + * Returns: (transfer full): the newly created #GChecksum, or %NULL. * Use g_checksum_free() to free the memory allocated by it. * * Since: 2.16 @@ -1487,7 +1487,7 @@ g_checksum_reset (GChecksum *checksum) * g_checksum_get_string() or g_checksum_get_digest(), the copied * checksum will be closed as well. * - * Return value: the copy of the passed #GChecksum. Use g_checksum_free() + * Returns: the copy of the passed #GChecksum. Use g_checksum_free() * when finished using it. * * Since: 2.16 @@ -1588,7 +1588,7 @@ g_checksum_update (GChecksum *checksum, * * The hexadecimal characters will be lower case. * - * Return value: the hexadecimal representation of the checksum. The + * Returns: the hexadecimal representation of the checksum. The * returned string is owned by the checksum and should not be modified * or freed. * @@ -1720,7 +1720,7 @@ g_checksum_get_digest (GChecksum *checksum, * * The hexadecimal string returned will be in lower case. * - * Return value: the digest of the binary data as a string in hexadecimal. + * Returns: the digest of the binary data as a string in hexadecimal. * The returned string should be freed with g_free() when done using it. * * Since: 2.16 @@ -1757,7 +1757,7 @@ g_compute_checksum_for_data (GChecksumType checksum_type, * * The hexadecimal string returned will be in lower case. * - * Return value: the checksum as a hexadecimal string. The returned string + * Returns: the checksum as a hexadecimal string. The returned string * should be freed with g_free() when done using it. * * Since: 2.16 @@ -1787,7 +1787,7 @@ g_compute_checksum_for_string (GChecksumType checksum_type, * * The hexadecimal string returned will be in lower case. * - * Return value: the digest of the binary data as a string in hexadecimal. + * Returns: the digest of the binary data as a string in hexadecimal. * The returned string should be freed with g_free() when done using it. * * Since: 2.34 diff --git a/glib/gconvert.c b/glib/gconvert.c index 506f6b341..8831bd6e8 100644 --- a/glib/gconvert.c +++ b/glib/gconvert.c @@ -213,7 +213,7 @@ try_to_aliases (const char **to_aliases, * GLib provides g_convert() and g_locale_to_utf8() which are likely * more convenient than the raw iconv wrappers. * - * Return value: a "conversion descriptor", or (GIConv)-1 if + * Returns: a "conversion descriptor", or (GIConv)-1 if * opening the converter failed. **/ GIConv @@ -265,7 +265,7 @@ g_iconv_open (const gchar *to_codeset, * GLib provides g_convert() and g_locale_to_utf8() which are likely * more convenient than the raw iconv wrappers. * - * Return value: count of non-reversible conversions, or -1 on error + * Returns: count of non-reversible conversions, or -1 on error **/ gsize g_iconv (GIConv converter, @@ -292,7 +292,7 @@ g_iconv (GIConv converter, * GLib provides g_convert() and g_locale_to_utf8() which are likely * more convenient than the raw iconv wrappers. * - * Return value: -1 on error, 0 on success + * Returns: -1 on error, 0 on success **/ gint g_iconv_close (GIConv converter) @@ -372,7 +372,7 @@ close_converter (GIConv cd) * character until it knows that the next character is not a mark that * could combine with the base character.) * - * Return value: If the conversion was successful, a newly allocated + * Returns: If the conversion was successful, a newly allocated * nul-terminated string, which must be freed with * g_free(). Otherwise %NULL and @error will be set. **/ @@ -526,7 +526,7 @@ g_convert_with_iconv (const gchar *str, * character until it knows that the next character is not a mark that * could combine with the base character.) * - * Return value: If the conversion was successful, a newly allocated + * Returns: If the conversion was successful, a newly allocated * nul-terminated string, which must be freed with * g_free(). Otherwise %NULL and @error will be set. **/ @@ -610,7 +610,7 @@ g_convert (const gchar *str, * character until it knows that the next character is not a mark that * could combine with the base character.) * - * Return value: If the conversion was successful, a newly allocated + * Returns: If the conversion was successful, a newly allocated * nul-terminated string, which must be freed with * g_free(). Otherwise %NULL and @error will be set. **/ @@ -886,7 +886,7 @@ strdup_len (const gchar *string, * the C runtime (usually the same as that used by the operating * system) in the [current locale][setlocale] into a UTF-8 string. * - * Return value: A newly-allocated buffer containing the converted string, + * Returns: A newly-allocated buffer containing the converted string, * or %NULL on an error, and error will be set. **/ gchar * @@ -930,7 +930,7 @@ g_locale_to_utf8 (const gchar *opsysstring, * system) in the [current locale][setlocale]. On Windows this means * the system codepage. * - * Return value: A newly-allocated buffer containing the converted string, + * Returns: A newly-allocated buffer containing the converted string, * or %NULL on an error, and error will be set. **/ gchar * @@ -997,7 +997,7 @@ filename_charset_cache_free (gpointer data) * `G_FILENAME_ENCODING` value, the actual file names present * on a system might be in any random encoding or just gibberish. * - * Return value: %TRUE if the filename encoding is UTF-8. + * Returns: %TRUE if the filename encoding is UTF-8. * * Since: 2.6 */ @@ -1134,7 +1134,7 @@ get_filename_charset (const gchar **filename_charset) * for filenames; on other platforms, this function indirectly depends on * the [current locale][setlocale]. * - * Return value: The converted string, or %NULL on an error. + * Returns: The converted string, or %NULL on an error. **/ gchar* g_filename_to_utf8 (const gchar *opsysstring, @@ -1206,7 +1206,7 @@ g_filename_to_utf8 (const gchar *opsysstring, * on other platforms, this function indirectly depends on the * [current locale][setlocale]. * - * Return value: (array length=bytes_written) (element-type guint8) (transfer full): + * Returns: (array length=bytes_written) (element-type guint8) (transfer full): * The converted string, or %NULL on an error. **/ gchar* @@ -1536,7 +1536,7 @@ hostname_validate (const char *hostname) * Converts an escaped ASCII-encoded URI to a local filename in the * encoding used for filenames. * - * Return value: (type filename): a newly-allocated string holding + * Returns: (type filename): a newly-allocated string holding * the resulting filename, or %NULL on an error. **/ gchar * @@ -1695,7 +1695,7 @@ g_filename_from_uri (const gchar *uri, * Converts an absolute filename to an escaped ASCII-encoded URI, with the path * component following Section 3.3. of RFC 2396. * - * Return value: a newly-allocated string holding the resulting + * Returns: a newly-allocated string holding the resulting * URI, or %NULL on an error. **/ gchar * @@ -1854,7 +1854,7 @@ g_uri_list_extract_uris (const gchar *uri_list) * This function is preferred over g_filename_display_name() if you know the * whole path, as it allows translation. * - * Return value: a newly allocated string containing + * Returns: a newly allocated string containing * a rendition of the basename of the filename in valid UTF-8 * * Since: 2.6 @@ -1893,7 +1893,7 @@ g_filename_display_basename (const gchar *filename) * g_filename_display_basename(), since that allows location-based * translation of filenames. * - * Return value: a newly allocated string containing + * Returns: a newly allocated string containing * a rendition of the filename in valid UTF-8 * * Since: 2.6 diff --git a/glib/gdataset.c b/glib/gdataset.c index ec72fec23..6ca95d6ed 100644 --- a/glib/gdataset.c +++ b/glib/gdataset.c @@ -1217,7 +1217,7 @@ g_datalist_unset_flags (GData **datalist, * Gets flags values packed in together with the datalist. * See g_datalist_set_flags(). * - * Return value: the flags of the datalist + * Returns: the flags of the datalist * * Since: 2.8 **/ diff --git a/glib/gdatetime.c b/glib/gdatetime.c index 9272c0389..1771d0fe9 100644 --- a/glib/gdatetime.c +++ b/glib/gdatetime.c @@ -438,7 +438,7 @@ g_date_time_alloc (GTimeZone *tz) * * Atomically increments the reference count of @datetime by one. * - * Return value: the #GDateTime with the reference count increased + * Returns: the #GDateTime with the reference count increased * * Since: 2.26 */ @@ -1059,7 +1059,7 @@ g_date_time_new_utc (gint year, * * Creates a copy of @datetime and adds the specified timespan to the copy. * - * Return value: the newly created #GDateTime which should be freed with + * Returns: the newly created #GDateTime which should be freed with * g_date_time_unref(). * * Since: 2.26 @@ -1080,7 +1080,7 @@ g_date_time_add (GDateTime *datetime, * Creates a copy of @datetime and adds the specified number of years to the * copy. Add negative values to subtract years. * - * Return value: the newly created #GDateTime which should be freed with + * Returns: the newly created #GDateTime which should be freed with * g_date_time_unref(). * * Since: 2.26 @@ -1115,7 +1115,7 @@ g_date_time_add_years (GDateTime *datetime, * Creates a copy of @datetime and adds the specified number of months to the * copy. Add negative values to subtract months. * - * Return value: the newly created #GDateTime which should be freed with + * Returns: the newly created #GDateTime which should be freed with * g_date_time_unref(). * * Since: 2.26 @@ -1158,7 +1158,7 @@ g_date_time_add_months (GDateTime *datetime, * Creates a copy of @datetime and adds the specified number of weeks to the * copy. Add negative values to subtract weeks. * - * Return value: the newly created #GDateTime which should be freed with + * Returns: the newly created #GDateTime which should be freed with * g_date_time_unref(). * * Since: 2.26 @@ -1180,7 +1180,7 @@ g_date_time_add_weeks (GDateTime *datetime, * Creates a copy of @datetime and adds the specified number of days to the * copy. Add negative values to subtract days. * - * Return value: the newly created #GDateTime which should be freed with + * Returns: the newly created #GDateTime which should be freed with * g_date_time_unref(). * * Since: 2.26 @@ -1205,7 +1205,7 @@ g_date_time_add_days (GDateTime *datetime, * Creates a copy of @datetime and adds the specified number of hours. * Add negative values to subtract hours. * - * Return value: the newly created #GDateTime which should be freed with + * Returns: the newly created #GDateTime which should be freed with * g_date_time_unref(). * * Since: 2.26 @@ -1225,7 +1225,7 @@ g_date_time_add_hours (GDateTime *datetime, * Creates a copy of @datetime adding the specified number of minutes. * Add negative values to subtract minutes. * - * Return value: the newly created #GDateTime which should be freed with + * Returns: the newly created #GDateTime which should be freed with * g_date_time_unref(). * * Since: 2.26 @@ -1246,7 +1246,7 @@ g_date_time_add_minutes (GDateTime *datetime, * Creates a copy of @datetime and adds the specified number of seconds. * Add negative values to subtract seconds. * - * Return value: the newly created #GDateTime which should be freed with + * Returns: the newly created #GDateTime which should be freed with * g_date_time_unref(). * * Since: 2.26 @@ -1271,7 +1271,7 @@ g_date_time_add_seconds (GDateTime *datetime, * Creates a new #GDateTime adding the specified values to the current date and * time in @datetime. Add negative values to subtract. * - * Return value: the newly created #GDateTime that should be freed with + * Returns: the newly created #GDateTime that should be freed with * g_date_time_unref(). * * Since: 2.26 @@ -1367,7 +1367,7 @@ g_date_time_add_full (GDateTime *datetime, * A comparison function for #GDateTimes that is suitable * as a #GCompareFunc. Both #GDateTimes must be non-%NULL. * - * Return value: -1, 0 or 1 if @dt1 is less than, equal to or greater + * Returns: -1, 0 or 1 if @dt1 is less than, equal to or greater * than @dt2. * * Since: 2.26 @@ -1399,7 +1399,7 @@ g_date_time_compare (gconstpointer dt1, * #GTimeSpan that is returned is effectively @end - @begin (ie: * positive if the first parameter is larger). * - * Return value: the difference between the two #GDateTime, as a time + * Returns: the difference between the two #GDateTime, as a time * span expressed in microseconds. * * Since: 2.26 @@ -1421,7 +1421,7 @@ g_date_time_difference (GDateTime *end, * * Hashes @datetime into a #guint, suitable for use within #GHashTable. * - * Return value: a #guint containing the hash + * Returns: a #guint containing the hash * * Since: 2.26 */ @@ -1441,7 +1441,7 @@ g_date_time_hash (gconstpointer datetime) * Equal here means that they represent the same moment after converting * them to the same time zone. * - * Return value: %TRUE if @dt1 and @dt2 are equal + * Returns: %TRUE if @dt1 and @dt2 are equal * * Since: 2.26 */ @@ -1555,7 +1555,7 @@ end: * * Retrieves the year represented by @datetime in the Gregorian calendar. * - * Return value: the year represented by @datetime + * Returns: the year represented by @datetime * * Since: 2.26 */ @@ -1578,7 +1578,7 @@ g_date_time_get_year (GDateTime *datetime) * Retrieves the month of the year represented by @datetime in the Gregorian * calendar. * - * Return value: the month represented by @datetime + * Returns: the month represented by @datetime * * Since: 2.26 */ @@ -1601,7 +1601,7 @@ g_date_time_get_month (GDateTime *datetime) * Retrieves the day of the month represented by @datetime in the gregorian * calendar. * - * Return value: the day of the month + * Returns: the day of the month * * Since: 2.26 */ @@ -1749,7 +1749,7 @@ g_date_time_get_week_of_year (GDateTime *datetime) * Retrieves the ISO 8601 day of the week on which @datetime falls (1 is * Monday, 2 is Tuesday... 7 is Sunday). * - * Return value: the day of the week + * Returns: the day of the week * * Since: 2.26 */ @@ -1769,7 +1769,7 @@ g_date_time_get_day_of_week (GDateTime *datetime) * Retrieves the day of the year represented by @datetime in the Gregorian * calendar. * - * Return value: the day of the year + * Returns: the day of the year * * Since: 2.26 */ @@ -1792,7 +1792,7 @@ g_date_time_get_day_of_year (GDateTime *datetime) * * Retrieves the hour of the day represented by @datetime * - * Return value: the hour of the day + * Returns: the hour of the day * * Since: 2.26 */ @@ -1810,7 +1810,7 @@ g_date_time_get_hour (GDateTime *datetime) * * Retrieves the minute of the hour represented by @datetime * - * Return value: the minute of the hour + * Returns: the minute of the hour * * Since: 2.26 */ @@ -1828,7 +1828,7 @@ g_date_time_get_minute (GDateTime *datetime) * * Retrieves the second of the minute represented by @datetime * - * Return value: the second represented by @datetime + * Returns: the second represented by @datetime * * Since: 2.26 */ @@ -1846,7 +1846,7 @@ g_date_time_get_second (GDateTime *datetime) * * Retrieves the microsecond of the date represented by @datetime * - * Return value: the microsecond of the second + * Returns: the microsecond of the second * * Since: 2.26 */ diff --git a/glib/gdir.c b/glib/gdir.c index 64e42862b..e6cf5e634 100644 --- a/glib/gdir.c +++ b/glib/gdir.c @@ -129,7 +129,7 @@ g_dir_open_with_errno (const gchar *path, * directory can then be retrieved using g_dir_read_name(). Note * that the ordering is not defined. * - * Return value: a newly allocated #GDir on success, %NULL on failure. + * Returns: a newly allocated #GDir on success, %NULL on failure. * If non-%NULL, you must free the result with g_dir_close() * when you are finished with it. **/ @@ -241,7 +241,7 @@ g_dir_new_from_dirp (gpointer dirp) * On Windows, as is true of all GLib functions which operate on * filenames, the returned name is in UTF-8. * - * Return value: The entry's name or %NULL if there are no + * Returns: The entry's name or %NULL if there are no * more entries. The return value is owned by GLib and * must not be modified or freed. **/ diff --git a/glib/genviron.c b/glib/genviron.c index 44efd27e5..c11b599b1 100644 --- a/glib/genviron.c +++ b/glib/genviron.c @@ -76,7 +76,7 @@ g_environ_find (gchar **envp, * Returns the value of the environment variable @variable in the * provided list @envp. * - * Return value: the value of the environment variable, or %NULL if + * Returns: the value of the environment variable, or %NULL if * the environment variable is not set in @envp. The returned * string is owned by @envp, and will be freed if @variable is * set or unset again. @@ -111,7 +111,7 @@ g_environ_getenv (gchar **envp, * Sets the environment variable @variable in the provided list * @envp to @value. * - * Return value: (array zero-terminated=1) (transfer full): the + * Returns: (array zero-terminated=1) (transfer full): the * updated environment list. Free it using g_strfreev(). * * Since: 2.32 @@ -195,7 +195,7 @@ g_environ_unsetenv_internal (gchar **envp, * Removes the environment variable @variable from the provided * environment @envp. * - * Return value: (array zero-terminated=1) (transfer full): the + * Returns: (array zero-terminated=1) (transfer full): the * updated environment list. Free it using g_strfreev(). * * Since: 2.32 @@ -229,7 +229,7 @@ g_environ_unsetenv (gchar **envp, * On Windows, in case the environment variable's value contains * references to other environment variables, they are expanded. * - * Return value: the value of the environment variable, or %NULL if + * Returns: the value of the environment variable, or %NULL if * the environment variable is not found. The returned string * may be overwritten by the next call to g_getenv(), g_setenv() * or g_unsetenv(). diff --git a/glib/gerror.c b/glib/gerror.c index d0d85238a..a542611de 100644 --- a/glib/gerror.c +++ b/glib/gerror.c @@ -396,7 +396,7 @@ g_error_new_valist (GQuark domain, * Creates a new #GError with the given @domain and @code, * and a message formatted with @format. * - * Return value: a new #GError + * Returns: a new #GError */ GError* g_error_new (GQuark domain, @@ -428,7 +428,7 @@ g_error_new (GQuark domain, * @message contains text you don't have control over, * that could include printf() escape sequences. * - * Return value: a new #GError + * Returns: a new #GError **/ GError* g_error_new_literal (GQuark domain, @@ -471,7 +471,7 @@ g_error_free (GError *error) * * Makes a copy of @error. * - * Return value: a new #GError + * Returns: a new #GError */ GError* g_error_copy (const GError *error) @@ -502,7 +502,7 @@ g_error_copy (const GError *error) * otherwise. In particular, when @error is %NULL, %FALSE will * be returned. * - * Return value: whether @error has @domain and @code + * Returns: whether @error has @domain and @code */ gboolean g_error_matches (const GError *error, diff --git a/glib/gfileutils.c b/glib/gfileutils.c index a18c69892..c80c1ef68 100644 --- a/glib/gfileutils.c +++ b/glib/gfileutils.c @@ -311,7 +311,7 @@ g_mkdir_with_parents (const gchar *pathname, * its name indicates that it is executable, checking for well-known * extensions and those listed in the `PATHEXT` environment variable. * - * Return value: whether a test was %TRUE + * Returns: whether a test was %TRUE **/ gboolean g_file_test (const gchar *filename, @@ -473,7 +473,7 @@ G_DEFINE_QUARK (g-file-error-quark, g_file_error) * from a function that manipulates files. So you would use * g_file_error_from_errno() when constructing a #GError. * - * Return value: #GFileError corresponding to the given @errno + * Returns: #GFileError corresponding to the given @errno **/ GFileError g_file_error_from_errno (gint err_no) @@ -957,7 +957,7 @@ get_contents_win32 (const gchar *filename, * codes are those in the #GFileError enumeration. In the error case, * @contents is set to %NULL and @length is set to zero. * - * Return value: %TRUE on success, %FALSE if an error occurred + * Returns: %TRUE on success, %FALSE if an error occurred **/ gboolean g_file_get_contents (const gchar *filename, @@ -1154,7 +1154,7 @@ write_to_temp_file (const gchar *contents, * Note that the name for the temporary file is constructed by appending up * to 7 characters to @filename. * - * Return value: %TRUE on success, %FALSE if an error occurred + * Returns: %TRUE on success, %FALSE if an error occurred * * Since: 2.8 */ @@ -1345,7 +1345,7 @@ wrap_g_open (const gchar *filename, * in the GLib file name encoding. Most importantly, on Windows it * should be in UTF-8. * - * Return value: A pointer to @tmpl, which has been modified + * Returns: A pointer to @tmpl, which has been modified * to hold the directory name. In case of errors, %NULL is * returned, and %errno will be set. * @@ -1377,7 +1377,7 @@ g_mkdtemp_full (gchar *tmpl, * The string should be in the GLib file name encoding. Most importantly, * on Windows it should be in UTF-8. * - * Return value: A pointer to @tmpl, which has been modified + * Returns: A pointer to @tmpl, which has been modified * to hold the directory name. In case of errors, %NULL is * returned and %errno will be set. * @@ -1408,7 +1408,7 @@ g_mkdtemp (gchar *tmpl) * The string should be in the GLib file name encoding. Most importantly, * on Windows it should be in UTF-8. * - * Return value: A file handle (as from open()) to the file + * Returns: A file handle (as from open()) to the file * opened for reading and writing. The file handle should be * closed with close(). In case of errors, -1 is returned * and %errno will be set. @@ -1440,7 +1440,7 @@ g_mkstemp_full (gchar *tmpl, * didn't exist. The string should be in the GLib file name encoding. * Most importantly, on Windows it should be in UTF-8. * - * Return value: A file handle (as from open()) to the file + * Returns: A file handle (as from open()) to the file * opened for reading and writing. The file is opened in binary * mode on platforms where there is a difference. The file handle * should be closed with close(). In case of errors, -1 is @@ -1551,7 +1551,7 @@ g_get_tmp_name (const gchar *tmpl, * when not needed any longer. The returned name is in the GLib file * name encoding. * - * Return value: A file handle (as from open()) to the file opened for + * Returns: A file handle (as from open()) to the file opened for * reading and writing. The file is opened in binary mode on platforms * where there is a difference. The file handle should be closed with * close(). In case of errors, -1 is returned and @error will be set. @@ -1598,7 +1598,7 @@ g_file_open_tmp (const gchar *tmpl, * Note that in contrast to g_mkdtemp() (and mkdtemp()) @tmpl is not * modified, and might thus be a read-only literal string. * - * Return value: (type filename): The actual name used. This string + * Returns: (type filename): The actual name used. This string * should be freed with g_free() when not needed any longer and is * is in the GLib file name encoding. In case of errors, %NULL is * returned and @error will be set. @@ -1729,7 +1729,7 @@ g_build_path_va (const gchar *separator, * as a string array, instead of varargs. This function is mainly * meant for language bindings. * - * Return value: a newly-allocated string that must be freed with g_free(). + * Returns: a newly-allocated string that must be freed with g_free(). * * Since: 2.8 */ @@ -1777,7 +1777,7 @@ g_build_pathv (const gchar *separator, * copies of the separator, elements consisting only of copies * of the separator are ignored. * - * Return value: a newly-allocated string that must be freed with g_free(). + * Returns: a newly-allocated string that must be freed with g_free(). **/ gchar * g_build_path (const gchar *separator, @@ -1920,7 +1920,7 @@ g_build_pathname_va (const gchar *first_element, * as a string array, instead of varargs. This function is mainly * meant for language bindings. * - * Return value: a newly-allocated string that must be freed with g_free(). + * Returns: a newly-allocated string that must be freed with g_free(). * * Since: 2.8 */ @@ -1959,7 +1959,7 @@ g_build_filenamev (gchar **args) * path. If the first element is a relative path, the result will * be a relative path. * - * Return value: a newly-allocated string that must be freed with g_free(). + * Returns: a newly-allocated string that must be freed with g_free(). **/ gchar * g_build_filename (const gchar *first_element, @@ -2163,7 +2163,7 @@ g_path_skip_root (const gchar *file_name) * components. It returns a pointer into the given file name * string. * - * Return value: the name of the file without any leading + * Returns: the name of the file without any leading * directory components * * Deprecated:2.2: Use g_path_get_basename() instead, but notice @@ -2211,7 +2211,7 @@ g_basename (const gchar *file_name) * separators (and on Windows, possibly a drive letter), a single * separator is returned. If @file_name is empty, it gets ".". * - * Return value: a newly allocated string containing the last + * Returns: a newly allocated string containing the last * component of the filename */ gchar * diff --git a/glib/ggettext.c b/glib/ggettext.c index daadf7c08..636fdbba5 100644 --- a/glib/ggettext.c +++ b/glib/ggettext.c @@ -162,7 +162,7 @@ glib_pgettext (const gchar *msgctxtid, * * An auxiliary function for gettext() support (see Q_()). * - * Return value: @msgval, unless @msgval is identical to @msgid + * Returns: @msgval, unless @msgval is identical to @msgid * and contains a '|' character, in which case a pointer to * the substring of msgid after the first '|' character is returned. * diff --git a/glib/ghash.c b/glib/ghash.c index 012671d0c..de05efd92 100644 --- a/glib/ghash.c +++ b/glib/ghash.c @@ -617,7 +617,7 @@ g_hash_table_maybe_resize (GHashTable *hash_table) * a similar fashion to g_direct_equal(), but without the overhead of * a function call. * - * Return value: a new #GHashTable + * Returns: a new #GHashTable */ GHashTable * g_hash_table_new (GHashFunc hash_func, @@ -643,7 +643,7 @@ g_hash_table_new (GHashFunc hash_func, * allocated for the key and value that get called when removing the * entry from the #GHashTable. * - * Return value: a new #GHashTable + * Returns: a new #GHashTable */ GHashTable * g_hash_table_new_full (GHashFunc hash_func, @@ -719,7 +719,7 @@ g_hash_table_iter_init (GHashTableIter *iter, * pointed to as a result of this advancement. If %FALSE is returned, * @key and @value are not set, and the iterator becomes invalid. * - * Return value: %FALSE if the end of the #GHashTable has been reached. + * Returns: %FALSE if the end of the #GHashTable has been reached. * * Since: 2.16 */ @@ -765,7 +765,7 @@ g_hash_table_iter_next (GHashTableIter *iter, * * Returns the #GHashTable associated with @iter. * - * Return value: the #GHashTable associated with @iter. + * Returns: the #GHashTable associated with @iter. * * Since: 2.16 */ @@ -998,7 +998,7 @@ g_hash_table_iter_steal (GHashTableIter *iter) * Atomically increments the reference count of @hash_table by one. * This function is MT-safe and may be called from any thread. * - * Return value: the passed in #GHashTable + * Returns: the passed in #GHashTable * * Since: 2.10 */ @@ -1069,7 +1069,7 @@ g_hash_table_destroy (GHashTable *hash_table) * and has the value %NULL. If you need this distinction, use * g_hash_table_lookup_extended(). * - * Return value: (allow-none): the associated value, or %NULL if the key is not found + * Returns: (allow-none): the associated value, or %NULL if the key is not found */ gpointer g_hash_table_lookup (GHashTable *hash_table, @@ -1103,7 +1103,7 @@ g_hash_table_lookup (GHashTable *hash_table, * whether the %NULL key exists, provided the hash and equal functions * of @hash_table are %NULL-safe. * - * Return value: %TRUE if the key was found in the #GHashTable + * Returns: %TRUE if the key was found in the #GHashTable */ gboolean g_hash_table_lookup_extended (GHashTable *hash_table, @@ -1265,7 +1265,7 @@ g_hash_table_contains (GHashTable *hash_table, * @hash_table: our #GHashTable * @key: the key to remove * @notify: %TRUE if the destroy notify handlers are to be called - * Return value: %TRUE if a node was found and removed, else %FALSE + * Returns: %TRUE if a node was found and removed, else %FALSE * * Implements the common logic for the g_hash_table_remove() and * g_hash_table_steal() functions. @@ -1458,7 +1458,7 @@ g_hash_table_foreach_remove_or_steal (GHashTable *hash_table, * See #GHashTableIter for an alternative way to loop over the * key/value pairs in the hash table. * - * Return value: the number of key/value pairs removed + * Returns: the number of key/value pairs removed */ guint g_hash_table_foreach_remove (GHashTable *hash_table, @@ -1485,7 +1485,7 @@ g_hash_table_foreach_remove (GHashTable *hash_table, * See #GHashTableIter for an alternative way to loop over the * key/value pairs in the hash table. * - * Return value: the number of key/value pairs removed. + * Returns: the number of key/value pairs removed. */ guint g_hash_table_foreach_steal (GHashTable *hash_table, @@ -1566,7 +1566,7 @@ g_hash_table_foreach (GHashTable *hash_table, * (keep in mind that an O(n) find/foreach operation issued for all n * values in a hash table ends up needing O(n*n) operations). * - * Return value: (allow-none): The value of the first key/value pair is returned, + * Returns: (allow-none): The value of the first key/value pair is returned, * for which @predicate evaluates to %TRUE. If no pair with the * requested property is found, %NULL is returned. * @@ -1618,7 +1618,7 @@ g_hash_table_find (GHashTable *hash_table, * * Returns the number of elements contained in the #GHashTable. * - * Return value: the number of key/value pairs in the #GHashTable. + * Returns: the number of key/value pairs in the #GHashTable. */ guint g_hash_table_size (GHashTable *hash_table) @@ -1635,7 +1635,7 @@ g_hash_table_size (GHashTable *hash_table) * Retrieves every key inside @hash_table. The returned data is valid * until changes to the hash release those keys. * - * Return value: a #GList containing all the keys inside the hash + * Returns: a #GList containing all the keys inside the hash * table. The content of the list is owned by the hash table and * should not be modified or freed. Use g_list_free() when done * using the list. @@ -1713,7 +1713,7 @@ g_hash_table_get_keys_as_array (GHashTable *hash_table, * Retrieves every value inside @hash_table. The returned data * is valid until @hash_table is modified. * - * Return value: a #GList containing all the values inside the hash + * Returns: a #GList containing all the values inside the hash * table. The content of the list is owned by the hash table and * should not be modified or freed. Use g_list_free() when done * using the list. diff --git a/glib/ghmac.c b/glib/ghmac.c index 874383e53..c9f4ba1e6 100644 --- a/glib/ghmac.c +++ b/glib/ghmac.c @@ -80,7 +80,7 @@ struct _GHmac * will be closed and it won't be possible to call g_hmac_update() * on it anymore. * - * Return value: the newly created #GHmac, or %NULL. + * Returns: the newly created #GHmac, or %NULL. * Use g_hmac_unref() to free the memory allocated by it. * * Since: 2.30 @@ -160,7 +160,7 @@ g_hmac_new (GChecksumType digest_type, * g_hmac_get_string() or g_hmac_get_digest(), the copied * HMAC will be closed as well. * - * Return value: the copy of the passed #GHmac. Use g_hmac_unref() + * Returns: the copy of the passed #GHmac. Use g_hmac_unref() * when finished using it. * * Since: 2.30 @@ -189,7 +189,7 @@ g_hmac_copy (const GHmac *hmac) * * This function is MT-safe and may be called from any thread. * - * Return value: the passed in #GHmac. + * Returns: the passed in #GHmac. * * Since: 2.30 **/ @@ -264,7 +264,7 @@ g_hmac_update (GHmac *hmac, * * The hexadecimal characters will be lower case. * - * Return value: the hexadecimal representation of the HMAC. The + * Returns: the hexadecimal representation of the HMAC. The * returned string is owned by the HMAC and should not be modified * or freed. * @@ -336,7 +336,7 @@ g_hmac_get_digest (GHmac *hmac, * * The hexadecimal string returned will be in lower case. * - * Return value: the HMAC of the binary data as a string in hexadecimal. + * Returns: the HMAC of the binary data as a string in hexadecimal. * The returned string should be freed with g_free() when done using it. * * Since: 2.30 @@ -376,7 +376,7 @@ g_compute_hmac_for_data (GChecksumType digest_type, * * The hexadecimal string returned will be in lower case. * - * Return value: the HMAC as a hexadecimal string. + * Returns: the HMAC as a hexadecimal string. * The returned string should be freed with g_free() * when done using it. * diff --git a/glib/ghostutils.c b/glib/ghostutils.c index 3182a128f..79e951446 100644 --- a/glib/ghostutils.c +++ b/glib/ghostutils.c @@ -413,7 +413,7 @@ idna_end_of_label (const gchar *str) * string containing no uppercase letters and not ending with a * trailing dot. * - * Return value: an ASCII hostname, which must be freed, or %NULL if + * Returns: an ASCII hostname, which must be freed, or %NULL if * @hostname is in some way invalid. * * Since: 2.22 @@ -487,7 +487,7 @@ g_hostname_to_ascii (const gchar *hostname) * segments, and so it is possible for g_hostname_is_non_ascii() and * g_hostname_is_ascii_encoded() to both return %TRUE for a name. * - * Return value: %TRUE if @hostname contains any non-ASCII characters + * Returns: %TRUE if @hostname contains any non-ASCII characters * * Since: 2.22 **/ @@ -594,7 +594,7 @@ punycode_decode (const gchar *input, * Of course if @hostname is not an internationalized hostname, then * the canonical presentation form will be entirely ASCII. * - * Return value: a UTF-8 hostname, which must be freed, or %NULL if + * Returns: a UTF-8 hostname, which must be freed, or %NULL if * @hostname is in some way invalid. * * Since: 2.22 @@ -658,7 +658,7 @@ g_hostname_to_unicode (const gchar *hostname) * segments, and so it is possible for g_hostname_is_non_ascii() and * g_hostname_is_ascii_encoded() to both return %TRUE for a name. * - * Return value: %TRUE if @hostname contains any ASCII-encoded + * Returns: %TRUE if @hostname contains any ASCII-encoded * segments. * * Since: 2.22 @@ -685,7 +685,7 @@ g_hostname_is_ascii_encoded (const gchar *hostname) * Tests if @hostname is the string form of an IPv4 or IPv6 address. * (Eg, "192.168.0.1".) * - * Return value: %TRUE if @hostname is an IP address + * Returns: %TRUE if @hostname is an IP address * * Since: 2.22 **/ diff --git a/glib/giochannel.c b/glib/giochannel.c index a5767c333..f13f6c598 100644 --- a/glib/giochannel.c +++ b/glib/giochannel.c @@ -294,7 +294,7 @@ g_io_error_get_from_g_error (GIOStatus status, * * Reads data from a #GIOChannel. * - * Return value: %G_IO_ERROR_NONE if the operation was successful. + * Returns: %G_IO_ERROR_NONE if the operation was successful. * * Deprecated:2.2: Use g_io_channel_read_chars() instead. **/ @@ -339,7 +339,7 @@ g_io_channel_read (GIOChannel *channel, * * Writes data to a #GIOChannel. * - * Return value: %G_IO_ERROR_NONE if the operation was successful. + * Returns: %G_IO_ERROR_NONE if the operation was successful. * * Deprecated:2.2: Use g_io_channel_write_chars() instead. **/ @@ -378,7 +378,7 @@ g_io_channel_write (GIOChannel *channel, * Sets the current position in the #GIOChannel, similar to the standard * library function fseek(). * - * Return value: %G_IO_ERROR_NONE if the operation was successful. + * Returns: %G_IO_ERROR_NONE if the operation was successful. * * Deprecated:2.2: Use g_io_channel_seek_position() instead. **/ @@ -432,7 +432,7 @@ g_io_channel_seek (GIOChannel *channel, * so will not cause problems, as long as no attempt is made to * access the channel after it is closed). * - * Return value: A #GIOChannel on success, %NULL on failure. + * Returns: A #GIOChannel on success, %NULL on failure. **/ /** @@ -478,7 +478,7 @@ g_io_channel_close (GIOChannel *channel) * flushed if @flush is %TRUE. The channel will not be freed until the * last reference is dropped using g_io_channel_unref(). * - * Return value: the status of the operation. + * Returns: the status of the operation. **/ GIOStatus g_io_channel_shutdown (GIOChannel *channel, @@ -714,7 +714,7 @@ g_io_add_watch (GIOChannel *channel, * is data to be read/space to write data in the internal buffers in * the #GIOChannel. Only the flags %G_IO_IN and %G_IO_OUT may be set. * - * Return value: A #GIOCondition + * Returns: A #GIOCondition **/ GIOCondition g_io_channel_get_buffer_condition (GIOChannel *channel) @@ -744,7 +744,7 @@ g_io_channel_get_buffer_condition (GIOChannel *channel) * * Converts an `errno` error number to a #GIOChannelError. * - * Return value: a #GIOChannelError error number, e.g. + * Returns: a #GIOChannelError error number, e.g. * %G_IO_CHANNEL_ERROR_INVAL. **/ GIOChannelError @@ -855,7 +855,7 @@ g_io_channel_set_buffer_size (GIOChannel *channel, * * Gets the buffer size. * - * Return value: the size of the buffer. + * Returns: the size of the buffer. **/ gsize g_io_channel_get_buffer_size (GIOChannel *channel) @@ -906,7 +906,7 @@ g_io_channel_set_line_term (GIOChannel *channel, * where in the file a line break occurs. A value of %NULL * indicates autodetection. * - * Return value: The line termination string. This value + * Returns: The line termination string. This value * is owned by GLib and must not be freed. **/ const gchar * @@ -929,7 +929,7 @@ g_io_channel_get_line_term (GIOChannel *channel, * * Sets the (writeable) flags in @channel to (@flags & %G_IO_FLAG_SET_MASK). * - * Return value: the status of the operation. + * Returns: the status of the operation. **/ /** * GIOFlags: @@ -986,7 +986,7 @@ g_io_channel_set_flags (GIOChannel *channel, * should immediately call g_io_channel_get_flags() to update * the internal values of these flags. * - * Return value: the flags which are set on the channel + * Returns: the flags which are set on the channel **/ GIOFlags g_io_channel_get_flags (GIOChannel *channel) @@ -1038,7 +1038,7 @@ g_io_channel_set_close_on_unref (GIOChannel *channel, * destroyed. The default value of this is %TRUE for channels created * by g_io_channel_new_file (), and %FALSE for all other channels. * - * Return value: Whether the channel will be closed on the final unref of + * Returns: Whether the channel will be closed on the final unref of * the GIOChannel data structure. **/ gboolean @@ -1061,7 +1061,7 @@ g_io_channel_get_close_on_unref (GIOChannel *channel) * * Replacement for g_io_channel_seek() with the new API. * - * Return value: the status of the operation. + * Returns: the status of the operation. **/ /** * GSeekType: @@ -1167,7 +1167,7 @@ g_io_channel_seek_position (GIOChannel *channel, * * Flushes the write buffer for the GIOChannel. * - * Return value: the status of the operation: One of + * Returns: the status of the operation: One of * #G_IO_STATUS_NORMAL, #G_IO_STATUS_AGAIN, or * #G_IO_STATUS_ERROR. **/ @@ -1437,7 +1437,7 @@ g_io_channel_set_encoding (GIOChannel *channel, * The internal encoding is always UTF-8. The encoding %NULL * makes the channel safe for binary data. * - * Return value: A string containing the encoding, this string is + * Returns: A string containing the encoding, this string is * owned by GLib and must not be freed. **/ const gchar * @@ -1637,7 +1637,7 @@ reencode: * @str_return will contain allocated memory if the return * is %G_IO_STATUS_NORMAL. * - * Return value: the status of the operation. + * Returns: the status of the operation. **/ GIOStatus g_io_channel_read_line (GIOChannel *channel, @@ -1684,7 +1684,7 @@ g_io_channel_read_line (GIOChannel *channel, * * Reads a line from a #GIOChannel, using a #GString as a buffer. * - * Return value: the status of the operation. + * Returns: the status of the operation. **/ GIOStatus g_io_channel_read_line_string (GIOChannel *channel, @@ -1898,7 +1898,7 @@ done: * * Reads all the remaining data from the file. * - * Return value: %G_IO_STATUS_NORMAL on success. + * Returns: %G_IO_STATUS_NORMAL on success. * This function never returns %G_IO_STATUS_EOF. **/ GIOStatus @@ -1982,7 +1982,7 @@ g_io_channel_read_to_end (GIOChannel *channel, * * Replacement for g_io_channel_read() with the new API. * - * Return value: the status of the operation. + * Returns: the status of the operation. */ GIOStatus g_io_channel_read_chars (GIOChannel *channel, @@ -2095,7 +2095,7 @@ g_io_channel_read_chars (GIOChannel *channel, * Reads a Unicode character from @channel. * This function cannot be called on a channel with %NULL encoding. * - * Return value: a #GIOStatus + * Returns: a #GIOStatus **/ GIOStatus g_io_channel_read_unichar (GIOChannel *channel, @@ -2167,7 +2167,7 @@ g_io_channel_read_unichar (GIOChannel *channel, * may only be made on a channel from which data has been read in the * cases described in the documentation for g_io_channel_set_encoding (). * - * Return value: the status of the operation. + * Returns: the status of the operation. **/ GIOStatus g_io_channel_write_chars (GIOChannel *channel, @@ -2494,7 +2494,7 @@ reconvert: * Writes a Unicode character to @channel. * This function cannot be called on a channel with %NULL encoding. * - * Return value: a #GIOStatus + * Returns: a #GIOStatus **/ GIOStatus g_io_channel_write_unichar (GIOChannel *channel, @@ -2532,7 +2532,7 @@ g_io_channel_write_unichar (GIOChannel *channel, /** * g_io_channel_error_quark: * - * Return value: the quark used as %G_IO_CHANNEL_ERROR + * Returns: the quark used as %G_IO_CHANNEL_ERROR **/ /** * G_IO_CHANNEL_ERROR: diff --git a/glib/gkeyfile.c b/glib/gkeyfile.c index 986805f80..f9ca303df 100644 --- a/glib/gkeyfile.c +++ b/glib/gkeyfile.c @@ -611,7 +611,7 @@ g_key_file_clear (GKeyFile *key_file) * g_key_file_load_from_dirs() or g_key_file_load_from_data_dirs() to * read an existing key file. * - * Return value: (transfer full): an empty #GKeyFile. + * Returns: (transfer full): an empty #GKeyFile. * * Since: 2.6 **/ @@ -814,7 +814,7 @@ g_key_file_load_from_fd (GKeyFile *key_file, * If the file could not be loaded then @error is set to * either a #GFileError or #GKeyFileError. * - * Return value: %TRUE if a key file could be loaded, %FALSE otherwise + * Returns: %TRUE if a key file could be loaded, %FALSE otherwise * * Since: 2.6 **/ @@ -863,7 +863,7 @@ g_key_file_load_from_file (GKeyFile *key_file, * Loads a key file from memory into an empty #GKeyFile structure. * If the object cannot be created then %error is set to a #GKeyFileError. * - * Return value: %TRUE if a key file could be loaded, %FALSE otherwise + * Returns: %TRUE if a key file could be loaded, %FALSE otherwise * * Since: 2.6 **/ @@ -924,7 +924,7 @@ g_key_file_load_from_data (GKeyFile *key_file, * be loaded then an %error is set to either a #GFileError or * #GKeyFileError. * - * Return value: %TRUE if a key file could be loaded, %FALSE otherwise + * Returns: %TRUE if a key file could be loaded, %FALSE otherwise * * Since: 2.14 **/ @@ -997,7 +997,7 @@ g_key_file_load_from_dirs (GKeyFile *key_file, * @full_path. If the file could not be loaded then an %error is * set to either a #GFileError or #GKeyFileError. * - * Return value: %TRUE if a key file could be loaded, %FALSE othewise + * Returns: %TRUE if a key file could be loaded, %FALSE othewise * Since: 2.6 **/ gboolean @@ -1432,7 +1432,7 @@ g_key_file_flush_parse_buffer (GKeyFile *key_file, * Note that this function never reports an error, * so it is safe to pass %NULL as @error. * - * Return value: a newly allocated string holding + * Returns: a newly allocated string holding * the contents of the #GKeyFile * * Since: 2.6 @@ -1502,7 +1502,7 @@ g_key_file_to_data (GKeyFile *key_file, * be found, %NULL is returned and @error is set to * #G_KEY_FILE_ERROR_GROUP_NOT_FOUND. * - * Return value: (array zero-terminated=1) (transfer full): a newly-allocated %NULL-terminated array of strings. + * Returns: (array zero-terminated=1) (transfer full): a newly-allocated %NULL-terminated array of strings. * Use g_strfreev() to free it. * * Since: 2.6 @@ -1573,7 +1573,7 @@ g_key_file_get_keys (GKeyFile *key_file, * * Returns the name of the start group of the file. * - * Return value: The start group of the key file. + * Returns: The start group of the key file. * * Since: 2.6 **/ @@ -1597,7 +1597,7 @@ g_key_file_get_start_group (GKeyFile *key_file) * The array of returned groups will be %NULL-terminated, so * @length may optionally be %NULL. * - * Return value: (array zero-terminated=1) (transfer full): a newly-allocated %NULL-terminated array of strings. + * Returns: (array zero-terminated=1) (transfer full): a newly-allocated %NULL-terminated array of strings. * Use g_strfreev() to free it. * Since: 2.6 **/ @@ -1664,7 +1664,7 @@ g_key_file_get_groups (GKeyFile *key_file, * and @error is set to #G_KEY_FILE_ERROR_GROUP_NOT_FOUND. * * - * Return value: a newly allocated string or %NULL if the specified + * Returns: a newly allocated string or %NULL if the specified * key cannot be found. * * Since: 2.6 @@ -1775,7 +1775,7 @@ g_key_file_set_value (GKeyFile *key_file, * event that the @group_name cannot be found, %NULL is returned * and @error is set to #G_KEY_FILE_ERROR_GROUP_NOT_FOUND. * - * Return value: a newly allocated string or %NULL if the specified + * Returns: a newly allocated string or %NULL if the specified * key cannot be found. * * Since: 2.6 @@ -1886,7 +1886,7 @@ g_key_file_set_string (GKeyFile *key_file, * event that the @group_name cannot be found, %NULL is returned * and @error is set to #G_KEY_FILE_ERROR_GROUP_NOT_FOUND. * - * Return value: (array zero-terminated=1 length=length) (element-type utf8) (transfer full): + * Returns: (array zero-terminated=1 length=length) (element-type utf8) (transfer full): * a %NULL-terminated string array or %NULL if the specified * key cannot be found. The array should be freed with g_strfreev(). * @@ -2064,7 +2064,7 @@ g_key_file_set_locale_string (GKeyFile *key_file, * with @key cannot be interpreted or no suitable translation can * be found then the untranslated value is returned. * - * Return value: a newly allocated string or %NULL if the specified + * Returns: a newly allocated string or %NULL if the specified * key cannot be found. * * Since: 2.6 @@ -2154,7 +2154,7 @@ g_key_file_get_locale_string (GKeyFile *key_file, * returned array is %NULL-terminated, so @length may optionally * be %NULL. * - * Return value: (array zero-terminated=1 length=length) (element-type utf8) (transfer full): a newly allocated %NULL-terminated string array + * Returns: (array zero-terminated=1 length=length) (element-type utf8) (transfer full): a newly allocated %NULL-terminated string array * or %NULL if the key isn't found. The string array should be freed * with g_strfreev(). * @@ -2274,7 +2274,7 @@ g_key_file_set_locale_string_list (GKeyFile *key_file, * associated with @key cannot be interpreted as a boolean then %FALSE * is returned and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE. * - * Return value: the value associated with the key as a boolean, + * Returns: the value associated with the key as a boolean, * or %FALSE if the key was not found or could not be parsed. * * Since: 2.6 @@ -2368,7 +2368,7 @@ g_key_file_set_boolean (GKeyFile *key_file, * with @key cannot be interpreted as booleans then %NULL is returned * and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE. * - * Return value: (array length=length) (element-type gboolean) (transfer container): + * Returns: (array length=length) (element-type gboolean) (transfer container): * the values associated with the key as a list of booleans, or %NULL if the * key was not found or could not be parsed. The returned list of booleans * should be freed with g_free() when no longer needed. @@ -2489,7 +2489,7 @@ g_key_file_set_boolean_list (GKeyFile *key_file, * with @key cannot be interpreted as an integer then 0 is returned * and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE. * - * Return value: the value associated with the key as an integer, or + * Returns: the value associated with the key as an integer, or * 0 if the key was not found or could not be parsed. * * Since: 2.6 @@ -2739,7 +2739,7 @@ g_key_file_set_uint64 (GKeyFile *key_file, * with @key cannot be interpreted as integers then %NULL is returned * and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE. * - * Return value: (array length=length) (element-type gint) (transfer container): + * Returns: (array length=length) (element-type gint) (transfer container): * the values associated with the key as a list of integers, or %NULL if * the key was not found or could not be parsed. The returned list of * integers should be freed with g_free() when no longer needed. @@ -2857,7 +2857,7 @@ g_key_file_set_integer_list (GKeyFile *key_file, * with @key cannot be interpreted as a double then 0.0 is returned * and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE. * - * Return value: the value associated with the key as a double, or + * Returns: the value associated with the key as a double, or * 0.0 if the key was not found or could not be parsed. * * Since: 2.12 @@ -2952,7 +2952,7 @@ g_key_file_set_double (GKeyFile *key_file, * with @key cannot be interpreted as doubles then %NULL is returned * and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE. * - * Return value: (array length=length) (element-type gdouble) (transfer container): + * Returns: (array length=length) (element-type gdouble) (transfer container): * the values associated with the key as a list of doubles, or %NULL if the * key was not found or could not be parsed. The returned list of doubles * should be freed with g_free() when no longer needed. @@ -3499,7 +3499,7 @@ g_key_file_remove_comment (GKeyFile *key_file, * * Looks whether the key file has the group @group_name. * - * Return value: %TRUE if @group_name is a part of @key_file, %FALSE + * Returns: %TRUE if @group_name is a part of @key_file, %FALSE * otherwise. * Since: 2.6 **/ @@ -3567,7 +3567,7 @@ g_key_file_has_key_full (GKeyFile *key_file, * Language bindings should use g_key_file_get_value() to test whether * or not a key exists. * - * Return value: %TRUE if @key is a part of @group_name, %FALSE otherwise + * Returns: %TRUE if @key is a part of @group_name, %FALSE otherwise * * Since: 2.6 **/ diff --git a/glib/gmain.c b/glib/gmain.c index 6bb726e16..f2d6178de 100644 --- a/glib/gmain.c +++ b/glib/gmain.c @@ -575,7 +575,7 @@ g_main_context_new_with_next_id (guint next_id) * * Creates a new #GMainContext structure. * - * Return value: the new #GMainContext + * Returns: the new #GMainContext **/ GMainContext * g_main_context_new (void) @@ -641,7 +641,7 @@ g_main_context_new (void) * specified, and corresponds to the "main" main loop. See also * g_main_context_get_thread_default(). * - * Return value: (transfer none): the global default main context. + * Returns: (transfer none): the global default main context. **/ GMainContext * g_main_context_default (void) @@ -844,7 +844,7 @@ g_main_context_ref_thread_default (void) * and must be added to one with g_source_attach() before it will be * executed. * - * Return value: the newly-created #GSource. + * Returns: the newly-created #GSource. **/ GSource * g_source_new (GSourceFuncs *source_funcs, @@ -1161,7 +1161,7 @@ g_source_attach_unlocked (GSource *source, * Adds a #GSource to a @context so that it will be executed within * that context. Remove it by calling g_source_destroy(). * - * Return value: the ID (greater than 0) for the source within the + * Returns: the ID (greater than 0) for the source within the * #GMainContext. **/ guint @@ -1277,7 +1277,7 @@ g_source_destroy (GSource *source) * context. The reverse * mapping from ID to source is done by g_main_context_find_source_by_id(). * - * Return value: the ID (greater than 0) for the source + * Returns: the ID (greater than 0) for the source **/ guint g_source_get_id (GSource *source) @@ -1307,7 +1307,7 @@ g_source_get_id (GSource *source) * g_main_current_source(). But calling this function on a source * whose #GMainContext has been destroyed is an error. * - * Return value: (transfer none) (allow-none): the #GMainContext with which the + * Returns: (transfer none) (allow-none): the #GMainContext with which the * source is associated, or %NULL if the context has not * yet been added to a source. **/ @@ -1726,7 +1726,7 @@ g_source_set_priority (GSource *source, * * Gets the priority of a source. * - * Return value: the priority of the source + * Returns: the priority of the source **/ gint g_source_get_priority (GSource *source) @@ -1848,7 +1848,7 @@ g_source_set_can_recurse (GSource *source, * Checks whether a source is allowed to be called recursively. * see g_source_set_can_recurse(). * - * Return value: whether recursion is allowed. + * Returns: whether recursion is allowed. **/ gboolean g_source_get_can_recurse (GSource *source) @@ -1901,7 +1901,7 @@ g_source_set_name (GSource *source, * The name may be #NULL if it has never been set with * g_source_set_name(). * - * Return value: the name of the source + * Returns: the name of the source * Since: 2.26 **/ const char * @@ -1946,7 +1946,7 @@ g_source_set_name_by_id (guint tag, * * Increases the reference count on a source by one. * - * Return value: @source + * Returns: @source **/ GSource * g_source_ref (GSource *source) @@ -2060,7 +2060,7 @@ g_source_unref (GSource *source) * * Finds a #GSource given a pair of context and ID. * - * Return value: (transfer none): the #GSource if found, otherwise, %NULL + * Returns: (transfer none): the #GSource if found, otherwise, %NULL **/ GSource * g_main_context_find_source_by_id (GMainContext *context, @@ -2100,7 +2100,7 @@ g_main_context_find_source_by_id (GMainContext *context, * multiple sources exist with the same source function and user data, * the first one found will be returned. * - * Return value: (transfer none): the source, if one was found, otherwise %NULL + * Returns: (transfer none): the source, if one was found, otherwise %NULL **/ GSource * g_main_context_find_source_by_funcs_user_data (GMainContext *context, @@ -2149,7 +2149,7 @@ g_main_context_find_source_by_funcs_user_data (GMainContext *context, * multiple sources exist with the same user data, the first * one found will be returned. * - * Return value: (transfer none): the source, if one was found, otherwise %NULL + * Returns: (transfer none): the source, if one was found, otherwise %NULL **/ GSource * g_main_context_find_source_by_user_data (GMainContext *context, @@ -2202,7 +2202,7 @@ g_main_context_find_source_by_user_data (GMainContext *context, * * It is a programmer error to attempt to remove a non-existent source. * - * Return value: For historical reasons, this function always returns %TRUE + * Returns: For historical reasons, this function always returns %TRUE **/ gboolean g_source_remove (guint tag) @@ -2228,7 +2228,7 @@ g_source_remove (guint tag) * data for the callback. If multiple sources exist with the same user * data, only one will be destroyed. * - * Return value: %TRUE if a source was found and removed. + * Returns: %TRUE if a source was found and removed. **/ gboolean g_source_remove_by_user_data (gpointer user_data) @@ -2254,7 +2254,7 @@ g_source_remove_by_user_data (gpointer user_data) * source functions and user data. If multiple sources exist with the * same source functions and user data, only one will be destroyed. * - * Return value: %TRUE if a source was found and removed. + * Returns: %TRUE if a source was found and removed. **/ gboolean g_source_remove_by_funcs_user_data (GSourceFuncs *funcs, @@ -2837,7 +2837,7 @@ get_dispatch (void) * simply return to the main loop and then get called again when * there is more work to do. * - * Return value: The main loop recursion level in the current thread + * Returns: The main loop recursion level in the current thread */ int g_main_depth (void) @@ -2851,7 +2851,7 @@ g_main_depth (void) * * Returns the currently firing source for this thread. * - * Return value: (transfer none): The currently firing source or %NULL. + * Returns: (transfer none): The currently firing source or %NULL. * * Since: 2.12 */ @@ -2927,7 +2927,7 @@ g_main_current_source (void) * } * ]| * - * Return value: %TRUE if the source has been destroyed + * Returns: %TRUE if the source has been destroyed * * Since: 2.12 */ @@ -3111,7 +3111,7 @@ g_main_dispatch (GMainContext *context) * can call g_main_context_prepare(), g_main_context_query(), * g_main_context_check(), g_main_context_dispatch(). * - * Return value: %TRUE if the operation succeeded, and + * Returns: %TRUE if the operation succeeded, and * this thread is now the owner of @context. **/ gboolean @@ -3195,7 +3195,7 @@ g_main_context_release (GMainContext *context) * that owner releases ownership or until @cond is signaled, then * try again (once) to become the owner. * - * Return value: %TRUE if the operation succeeded, and + * Returns: %TRUE if the operation succeeded, and * this thread is now the owner of @context. **/ gboolean @@ -3260,7 +3260,7 @@ g_main_context_wait (GMainContext *context, * Prepares to poll sources within a main loop. The resulting information * for polling is determined by calling g_main_context_query (). * - * Return value: %TRUE if some source is ready to be dispatched + * Returns: %TRUE if some source is ready to be dispatched * prior to polling. **/ gboolean @@ -3420,7 +3420,7 @@ g_main_context_prepare (GMainContext *context, * * Determines information necessary to poll this main loop. * - * Return value: the number of records actually stored in @fds, + * Returns: the number of records actually stored in @fds, * or, if more than @n_fds records need to be stored, the number * of records that need to be stored. **/ @@ -3485,7 +3485,7 @@ g_main_context_query (GMainContext *context, * * Passes the results of polling back to the main loop. * - * Return value: %TRUE if some sources are ready to be dispatched. + * Returns: %TRUE if some sources are ready to be dispatched. **/ gboolean g_main_context_check (GMainContext *context, @@ -3724,7 +3724,7 @@ g_main_context_iterate (GMainContext *context, * * Checks if any sources have pending events for the given context. * - * Return value: %TRUE if events are pending. + * Returns: %TRUE if events are pending. **/ gboolean g_main_context_pending (GMainContext *context) @@ -3759,7 +3759,7 @@ g_main_context_pending (GMainContext *context) * g_main_context_iteration() to return %FALSE, since the wait may * be interrupted for other reasons than an event source becoming ready. * - * Return value: %TRUE if events were dispatched. + * Returns: %TRUE if events were dispatched. **/ gboolean g_main_context_iteration (GMainContext *context, gboolean may_block) @@ -3785,7 +3785,7 @@ g_main_context_iteration (GMainContext *context, gboolean may_block) * * Creates a new #GMainLoop structure. * - * Return value: a new #GMainLoop. + * Returns: a new #GMainLoop. **/ GMainLoop * g_main_loop_new (GMainContext *context, @@ -3812,7 +3812,7 @@ g_main_loop_new (GMainContext *context, * * Increases the reference count on a #GMainLoop object by one. * - * Return value: @loop + * Returns: @loop **/ GMainLoop * g_main_loop_ref (GMainLoop *loop) @@ -3943,7 +3943,7 @@ g_main_loop_quit (GMainLoop *loop) * * Checks to see if the main loop is currently being run via g_main_loop_run(). * - * Return value: %TRUE if the mainloop is currently being run. + * Returns: %TRUE if the mainloop is currently being run. **/ gboolean g_main_loop_is_running (GMainLoop *loop) @@ -3960,7 +3960,7 @@ g_main_loop_is_running (GMainLoop *loop) * * Returns the #GMainContext of @loop. * - * Return value: (transfer none): the #GMainContext of @loop + * Returns: (transfer none): the #GMainContext of @loop **/ GMainContext * g_main_loop_get_context (GMainLoop *loop) @@ -4291,7 +4291,7 @@ g_main_context_set_poll_func (GMainContext *context, * * Gets the poll function set by g_main_context_set_poll_func(). * - * Return value: the poll function + * Returns: the poll function **/ GPollFunc g_main_context_get_poll_func (GMainContext *context) @@ -4468,7 +4468,7 @@ g_timeout_dispatch (GSource *source, * The interval given is in terms of monotonic time, not wall clock * time. See g_get_monotonic_time(). * - * Return value: the newly-created timeout source + * Returns: the newly-created timeout source **/ GSource * g_timeout_source_new (guint interval) @@ -4498,7 +4498,7 @@ g_timeout_source_new (guint interval) * The interval given in terms of monotonic time, not wall clock time. * See g_get_monotonic_time(). * - * Return value: the newly-created timeout source + * Returns: the newly-created timeout source * * Since: 2.14 **/ @@ -4547,7 +4547,7 @@ g_timeout_source_new_seconds (guint interval) * The interval given in terms of monotonic time, not wall clock time. * See g_get_monotonic_time(). * - * Return value: the ID (greater than 0) of the event source. + * Returns: the ID (greater than 0) of the event source. * Rename to: g_timeout_add **/ guint @@ -4605,7 +4605,7 @@ g_timeout_add_full (gint priority, * The interval given is in terms of monotonic time, not wall clock * time. See g_get_monotonic_time(). * - * Return value: the ID (greater than 0) of the event source. + * Returns: the ID (greater than 0) of the event source. **/ guint g_timeout_add (guint32 interval, @@ -4659,7 +4659,7 @@ g_timeout_add (guint32 interval, * The interval given is in terms of monotonic time, not wall clock * time. See g_get_monotonic_time(). * - * Return value: the ID (greater than 0) of the event source. + * Returns: the ID (greater than 0) of the event source. * * Rename to: g_timeout_add_seconds * Since: 2.14 @@ -4711,7 +4711,7 @@ g_timeout_add_seconds_full (gint priority, * The interval given is in terms of monotonic time, not wall clock * time. See g_get_monotonic_time(). * - * Return value: the ID (greater than 0) of the event source. + * Returns: the ID (greater than 0) of the event source. * * Since: 2.14 **/ @@ -5124,7 +5124,7 @@ g_unix_signal_handler (int signum) * be greater than 0 (i.e. this function must wait for a specific child, * and cannot wait for one of many children by using a nonpositive argument). * - * Return value: the newly-created child watch source + * Returns: the newly-created child watch source * * Since: 2.4 **/ @@ -5193,7 +5193,7 @@ g_child_watch_source_new (GPid pid) * using g_source_attach(). You can do these steps manually if you * need greater control. * - * Return value: the ID (greater than 0) of the event source. + * Returns: the ID (greater than 0) of the event source. * * Rename to: g_child_watch_add * Since: 2.4 @@ -5252,7 +5252,7 @@ g_child_watch_add_full (gint priority, * using g_source_attach(). You can do these steps manually if you * need greater control. * - * Return value: the ID (greater than 0) of the event source. + * Returns: the ID (greater than 0) of the event source. * * Since: 2.4 **/ @@ -5308,7 +5308,7 @@ g_idle_dispatch (GSource *source, * %G_PRIORITY_DEFAULT_IDLE, as compared to other sources which * have a default priority of %G_PRIORITY_DEFAULT. * - * Return value: the newly-created idle source + * Returns: the newly-created idle source **/ GSource * g_idle_source_new (void) @@ -5337,7 +5337,7 @@ g_idle_source_new (void) * and attaches it to the main loop context using g_source_attach(). * You can do these steps manually if you need greater control. * - * Return value: the ID (greater than 0) of the event source. + * Returns: the ID (greater than 0) of the event source. * Rename to: g_idle_add **/ guint @@ -5378,7 +5378,7 @@ g_idle_add_full (gint priority, * and attaches it to the main loop context using g_source_attach(). * You can do these steps manually if you need greater control. * - * Return value: the ID (greater than 0) of the event source. + * Returns: the ID (greater than 0) of the event source. **/ guint g_idle_add (GSourceFunc function, @@ -5393,7 +5393,7 @@ g_idle_add (GSourceFunc function, * * Removes the idle function with the given data. * - * Return value: %TRUE if an idle source was found and removed. + * Returns: %TRUE if an idle source was found and removed. **/ gboolean g_idle_remove_by_data (gpointer data) diff --git a/glib/gmappedfile.c b/glib/gmappedfile.c index 603028b86..7c8702d2f 100644 --- a/glib/gmappedfile.c +++ b/glib/gmappedfile.c @@ -233,7 +233,7 @@ mapped_file_new_from_fd (int fd, * size 0 (e.g. device files such as /dev/null), @error will be set * to the #GFileError value #G_FILE_ERROR_INVAL. * - * Return value: a newly allocated #GMappedFile which must be unref'd + * Returns: a newly allocated #GMappedFile which must be unref'd * with g_mapped_file_unref(), or %NULL if the mapping failed. * * Since: 2.8 @@ -291,7 +291,7 @@ g_mapped_file_new (const gchar *filename, * will not be modified, or if all modifications of the file are done * atomically (e.g. using g_file_set_contents()). * - * Return value: a newly allocated #GMappedFile which must be unref'd + * Returns: a newly allocated #GMappedFile which must be unref'd * with g_mapped_file_unref(), or %NULL if the mapping failed. * * Since: 2.32 @@ -368,7 +368,7 @@ g_mapped_file_free (GMappedFile *file) * Increments the reference count of @file by one. It is safe to call * this function from any thread. * - * Return value: the passed in #GMappedFile. + * Returns: the passed in #GMappedFile. * * Since: 2.22 **/ diff --git a/glib/gmarkup.c b/glib/gmarkup.c index d84068a19..390a23bfc 100644 --- a/glib/gmarkup.c +++ b/glib/gmarkup.c @@ -213,7 +213,7 @@ string_blank (GString *string) * the parse context can't continue to parse text (you have to * free it and create a new parse context). * - * Return value: a new #GMarkupParseContext + * Returns: a new #GMarkupParseContext **/ GMarkupParseContext * g_markup_parse_context_new (const GMarkupParser *parser, @@ -1114,7 +1114,7 @@ emit_end_element (GMarkupParseContext *context, * is reported, no further data may be fed to the #GMarkupParseContext; * all errors are fatal. * - * Return value: %FALSE if an error occurred, %TRUE on success + * Returns: %FALSE if an error occurred, %TRUE on success */ gboolean g_markup_parse_context_parse (GMarkupParseContext *context, @@ -1745,7 +1745,7 @@ g_markup_parse_context_parse (GMarkupParseContext *context, * This function reports an error if the document isn't complete, * for example if elements are still open. * - * Return value: %TRUE on success, %FALSE if an error was set + * Returns: %TRUE on success, %FALSE if an error was set */ gboolean g_markup_parse_context_end_parse (GMarkupParseContext *context, @@ -2220,7 +2220,7 @@ append_escaped_text (GString *str, * 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. * - * Return value: a newly allocated string with the escaped text + * Returns: a newly allocated string with the escaped text */ gchar* g_markup_escape_text (const gchar *text, @@ -2251,7 +2251,7 @@ g_markup_escape_text (const gchar *text, * Partially based on code from printf-parser.c, * Copyright (C) 1999-2000, 2002-2003 Free Software Foundation, Inc. * - * Return value: pointer to the next conversion in @format, + * Returns: pointer to the next conversion in @format, * or %NULL, if none. */ static const char * @@ -2375,7 +2375,7 @@ find_conversion (const char *format, * all string and character arguments in the fashion * of g_markup_escape_text(). See g_markup_printf_escaped(). * - * Return value: newly allocated result from formatting + * Returns: newly allocated result from formatting * operation. Free with g_free(). * * Since: 2.4 @@ -2535,7 +2535,7 @@ g_markup_vprintf_escaped (const gchar *format, * store, item); * ]| * - * Return value: newly allocated result from formatting + * Returns: newly allocated result from formatting * operation. Free with g_free(). * * Since: 2.4 @@ -2663,7 +2663,7 @@ g_markup_parse_boolean (const char *string, * %G_MARKUP_ERROR_INVALID_CONTENT). In all of these cases %FALSE * will be returned and @error will be set as appropriate. * - * Return value: %TRUE if successful + * Returns: %TRUE if successful * * Since: 2.16 **/ diff --git a/glib/gmem.c b/glib/gmem.c index c17dda43e..5363751f2 100644 --- a/glib/gmem.c +++ b/glib/gmem.c @@ -481,7 +481,7 @@ static gboolean vtable_set = FALSE; * * A different allocator can be set using g_mem_set_vtable(). * - * Return value: if %TRUE, malloc() and g_malloc() can be mixed. + * Returns: if %TRUE, malloc() and g_malloc() can be mixed. **/ gboolean g_mem_is_system_malloc (void) diff --git a/glib/gnode.c b/glib/gnode.c index 9bc1b2372..b529f48dc 100644 --- a/glib/gnode.c +++ b/glib/gnode.c @@ -174,7 +174,7 @@ g_node_unlink (GNode *node) * * Recursively copies a #GNode and its data. * - * Return value: a new #GNode containing copies of the data in @node. + * Returns: a new #GNode containing copies of the data in @node. * * Since: 2.4 **/ diff --git a/glib/goption.c b/glib/goption.c index c6497e5ca..31bbf164f 100644 --- a/glib/goption.c +++ b/glib/goption.c @@ -558,7 +558,7 @@ g_option_context_set_main_group (GOptionContext *context, * * Returns a pointer to the main group of @context. * - * Return value: the main group of @context, or %NULL if @context doesn't + * Returns: the main group of @context, or %NULL if @context doesn't * have a main group. Note that group belongs to @context and should * not be modified or freed. * @@ -1818,7 +1818,7 @@ platform_get_argv0 (void) * automatic character set conversion of string and filename * arguments. * - * Return value: %TRUE if the parsing was successful, + * Returns: %TRUE if the parsing was successful, * %FALSE if an error occurred * * Since: 2.6 @@ -2163,7 +2163,7 @@ g_option_context_parse (GOptionContext *context, * * Creates a new #GOptionGroup. * - * Return value: a newly created option group. It should be added + * Returns: a newly created option group. It should be added * to a #GOptionContext or freed with g_option_group_free(). * * Since: 2.6 diff --git a/glib/gpoll.c b/glib/gpoll.c index 561271561..2620c9a90 100644 --- a/glib/gpoll.c +++ b/glib/gpoll.c @@ -110,7 +110,7 @@ extern gboolean _g_main_poll_debug; * Windows, the easiest solution is to construct all of your * #GPollFDs with g_io_channel_win32_make_pollfd(). * - * Return value: the number of entries in @fds whose %revents fields + * Returns: the number of entries in @fds whose %revents fields * were filled in, or 0 if the operation timed out, or -1 on error or * if the call was interrupted. * diff --git a/glib/gqueue.c b/glib/gqueue.c index 2d6ea3e71..e93886db0 100644 --- a/glib/gqueue.c +++ b/glib/gqueue.c @@ -165,7 +165,7 @@ g_queue_is_empty (GQueue *queue) * * Returns the number of items in @queue. * - * Return value: the number of items in @queue + * Returns: the number of items in @queue * * Since: 2.4 */ @@ -202,7 +202,7 @@ g_queue_reverse (GQueue *queue) * queue consist of pointers to data, the pointers are copied, but the * actual data is not. * - * Return value: a copy of @queue + * Returns: a copy of @queue * * Since: 2.4 */ @@ -259,7 +259,7 @@ g_queue_foreach (GQueue *queue, * * Finds the first link in @queue which contains @data. * - * Return value: the first link in @queue which contains @data + * Returns: the first link in @queue which contains @data * * Since: 2.4 */ @@ -285,7 +285,7 @@ g_queue_find (GQueue *queue, * takes two gconstpointer arguments, the #GQueue element's data as the * first argument and the given user data as the second argument. * - * Return value: the found link, or %NULL if it wasn't found + * Returns: the found link, or %NULL if it wasn't found * * Since: 2.4 */ @@ -567,7 +567,7 @@ g_queue_pop_head_link (GQueue *queue) * * Returns the first link in @queue. * - * Return value: the first link in @queue, or %NULL if @queue is empty + * Returns: the first link in @queue, or %NULL if @queue is empty * * Since: 2.4 */ @@ -585,7 +585,7 @@ g_queue_peek_head_link (GQueue *queue) * * Returns the last link in @queue. * - * Return value: the last link in @queue, or %NULL if @queue is empty + * Returns: the last link in @queue, or %NULL if @queue is empty * * Since: 2.4 */ @@ -637,7 +637,7 @@ g_queue_pop_tail (GQueue *queue) * * Removes the @n'th element of @queue and returns its data. * - * Return value: the element's data, or %NULL if @n is off the end of @queue + * Returns: the element's data, or %NULL if @n is off the end of @queue * * Since: 2.4 */ @@ -702,7 +702,7 @@ g_queue_pop_tail_link (GQueue *queue) * * Removes and returns the link at the given position. * - * Return value: the @n'th link, or %NULL if @n is off the end of @queue + * Returns: the @n'th link, or %NULL if @n is off the end of @queue * * Since: 2.4 */ @@ -730,7 +730,7 @@ g_queue_pop_nth_link (GQueue *queue, * * Returns the link at the given position * - * Return value: the link at the @n'th position, or %NULL + * Returns: the link at the @n'th position, or %NULL * if @n is off the end of the list * * Since: 2.4 @@ -772,7 +772,7 @@ g_queue_peek_nth_link (GQueue *queue, * * Returns the position of @link_ in @queue. * - * Return value: the position of @link_, or -1 if the link is + * Returns: the position of @link_, or -1 if the link is * not part of @queue * * Since: 2.4 @@ -875,7 +875,7 @@ g_queue_peek_tail (GQueue *queue) * * Returns the @n'th element of @queue. * - * Return value: the data for the @n'th element of @queue, + * Returns: the data for the @n'th element of @queue, * or %NULL if @n is off the end of @queue * * Since: 2.4 @@ -903,7 +903,7 @@ g_queue_peek_nth (GQueue *queue, * * Returns the position of the first element in @queue which contains @data. * - * Return value: the position of the first element in @queue which + * Returns: the position of the first element in @queue which * contains @data, or -1 if no element in @queue contains @data * * Since: 2.4 @@ -924,7 +924,7 @@ g_queue_index (GQueue *queue, * * Removes the first element in @queue that contains @data. * - * Return value: %TRUE if @data was found and removed from @queue + * Returns: %TRUE if @data was found and removed from @queue * * Since: 2.4 */ @@ -951,7 +951,7 @@ g_queue_remove (GQueue *queue, * * Remove all elements whose data equals @data from @queue. * - * Return value: the number of elements removed from @queue + * Returns: the number of elements removed from @queue * * Since: 2.4 */ diff --git a/glib/grand.c b/glib/grand.c index f2a44d040..6b6ca9881 100644 --- a/glib/grand.c +++ b/glib/grand.c @@ -171,7 +171,7 @@ struct _GRand * * Creates a new random number generator initialized with @seed. * - * Return value: the new #GRand + * Returns: the new #GRand **/ GRand* g_rand_new_with_seed (guint32 seed) @@ -189,7 +189,7 @@ g_rand_new_with_seed (guint32 seed) * * Creates a new random number generator initialized with @seed. * - * Return value: the new #GRand + * Returns: the new #GRand * * Since: 2.4 */ @@ -211,7 +211,7 @@ g_rand_new_with_seed_array (const guint32 *seed, * * On Windows, the seed is taken from rand_s(). * - * Return value: the new #GRand + * Returns: the new #GRand */ GRand* g_rand_new (void) @@ -292,7 +292,7 @@ g_rand_free (GRand *rand) * This way you can take a snapshot of the random number generator for * replaying later. * - * Return value: the new #GRand + * Returns: the new #GRand * * Since: 2.4 */ @@ -429,7 +429,7 @@ g_rand_set_seed_array (GRand *rand, * Returns the next random #guint32 from @rand_ equally distributed over * the range [0..2^32-1]. * - * Return value: a random number + * Returns: a random number */ guint32 g_rand_int (GRand *rand) @@ -478,7 +478,7 @@ g_rand_int (GRand *rand) * Returns the next random #gint32 from @rand_ equally distributed over * the range [@begin..@end-1]. * - * Return value: a random number + * Returns: a random number */ gint32 g_rand_int_range (GRand *rand, @@ -561,7 +561,7 @@ g_rand_int_range (GRand *rand, * Returns the next random #gdouble from @rand_ equally distributed over * the range [0..1). * - * Return value: a random number + * Returns: a random number */ gdouble g_rand_double (GRand *rand) @@ -588,7 +588,7 @@ g_rand_double (GRand *rand) * Returns the next random #gdouble from @rand_ equally distributed over * the range [@begin..@end). * - * Return value: a random number + * Returns: a random number */ gdouble g_rand_double_range (GRand *rand, @@ -628,7 +628,7 @@ get_global_random (void) * Return a random #guint32 equally distributed over the range * [0..2^32-1]. * - * Return value: a random number + * Returns: a random number */ guint32 g_random_int (void) @@ -648,7 +648,7 @@ g_random_int (void) * Returns a random #gint32 equally distributed over the range * [@begin..@end-1]. * - * Return value: a random number + * Returns: a random number */ gint32 g_random_int_range (gint32 begin, @@ -666,7 +666,7 @@ g_random_int_range (gint32 begin, * * Returns a random #gdouble equally distributed over the range [0..1). * - * Return value: a random number + * Returns: a random number */ gdouble g_random_double (void) @@ -686,7 +686,7 @@ g_random_double (void) * Returns a random #gdouble equally distributed over the range * [@begin..@end). * - * Return value: a random number + * Returns: a random number */ gdouble g_random_double_range (gdouble begin, diff --git a/glib/gsequence.c b/glib/gsequence.c index 31093456c..76e24e73b 100644 --- a/glib/gsequence.c +++ b/glib/gsequence.c @@ -241,7 +241,7 @@ iter_compare (GSequenceIter *node1, * be called on all items when the sequence is destroyed and on items that * are removed from the sequence. * - * Return value: a new #GSequence + * Returns: a new #GSequence * * Since: 2.14 **/ @@ -362,7 +362,7 @@ g_sequence_foreach (GSequence *seq, * The @begin and @end iterators must both point to the same sequence * and @begin must come before or be equal to @end in the sequence. * - * Return value: a #GSequenceIter pointing somewhere in the + * Returns: a #GSequenceIter pointing somewhere in the * (@begin, @end) range * * Since: 2.14 @@ -397,7 +397,7 @@ g_sequence_range_get_midpoint (GSequenceIter *begin, * * The @a and @b iterators must point into the same sequence. * - * Return value: a negative number if @a comes before @b, 0 if they are + * Returns: a negative number if @a comes before @b, 0 if they are * equal, and a positive number if @a comes after @b * * Since: 2.14 @@ -433,7 +433,7 @@ g_sequence_iter_compare (GSequenceIter *a, * * Adds a new item to the end of @seq. * - * Return value: an iterator pointing to the new item + * Returns: an iterator pointing to the new item * * Since: 2.14 */ @@ -460,7 +460,7 @@ g_sequence_append (GSequence *seq, * * Adds a new item to the front of @seq * - * Return value: an iterator pointing to the new item + * Returns: an iterator pointing to the new item * * Since: 2.14 */ @@ -489,7 +489,7 @@ g_sequence_prepend (GSequence *seq, * * Inserts a new item just before the item pointed to by @iter. * - * Return value: an iterator pointing to the new item + * Returns: an iterator pointing to the new item * * Since: 2.14 */ @@ -690,7 +690,7 @@ g_sequence_sort (GSequence *seq, * if the first item comes before the second, and a positive value * if the second item comes before the first. * - * Return value: a #GSequenceIter pointing to the new item. + * Returns: a #GSequenceIter pointing to the new item. * * Since: 2.14 */ @@ -772,7 +772,7 @@ g_sequence_sort_changed (GSequenceIter *iter, * you want to add a large amount of data, call g_sequence_sort() after * doing unsorted insertions. * - * Return value: an #GSequenceIter pointing to the position where @data + * Returns: an #GSequenceIter pointing to the position where @data * would have been inserted according to @cmp_func and @cmp_data * * Since: 2.14 @@ -819,7 +819,7 @@ g_sequence_search (GSequence *seq, * you want to add a large amount of data, call g_sequence_sort() after * doing unsorted insertions. * - * Return value: an #GSequenceIter pointing to the position of the + * Returns: an #GSequenceIter pointing to the position of the * first item found equal to @data according to @cmp_func and * @cmp_data, or %NULL if no such item exists * @@ -980,7 +980,7 @@ g_sequence_sort_changed_iter (GSequenceIter *iter, * first iterator comes before the second, and a positive value * if the second iterator comes before the first. * - * Return value: a #GSequenceIter pointing to the new item + * Returns: a #GSequenceIter pointing to the new item * * Since: 2.14 */ @@ -1051,7 +1051,7 @@ g_sequence_insert_sorted_iter (GSequence *seq, * you want to add a large amount of data, call g_sequence_sort() after * doing unsorted insertions. * - * Return value: a #GSequenceIter pointing to the position in @seq + * Returns: a #GSequenceIter pointing to the position in @seq * where @data would have been inserted according to @iter_cmp * and @cmp_data * @@ -1109,7 +1109,7 @@ g_sequence_search_iter (GSequence *seq, * you want to add a large amount of data, call g_sequence_sort() after * doing unsorted insertions. * - * Return value: an #GSequenceIter pointing to the position of + * Returns: an #GSequenceIter pointing to the position of * the first item found equal to @data according to @cmp_func * and @cmp_data, or %NULL if no such item exists * @@ -1152,7 +1152,7 @@ g_sequence_lookup_iter (GSequence *seq, * * Returns the #GSequence that @iter points into. * - * Return value: the #GSequence that @iter points into + * Returns: the #GSequence that @iter points into * * Since: 2.14 */ @@ -1177,7 +1177,7 @@ g_sequence_iter_get_sequence (GSequenceIter *iter) * * Returns the data that @iter points to. * - * Return value: the data that @iter points to + * Returns: the data that @iter points to * * Since: 2.14 */ @@ -1233,7 +1233,7 @@ g_sequence_set (GSequenceIter *iter, * * Returns the length of @seq * - * Return value: the length of @seq + * Returns: the length of @seq * * Since: 2.14 */ @@ -1249,7 +1249,7 @@ g_sequence_get_length (GSequence *seq) * * Returns the end iterator for @seg * - * Return value: the end iterator for @seq + * Returns: the end iterator for @seq * * Since: 2.14 */ @@ -1267,7 +1267,7 @@ g_sequence_get_end_iter (GSequence *seq) * * Returns the begin iterator for @seq. * - * Return value: the begin iterator for @seq. + * Returns: the begin iterator for @seq. * * Since: 2.14 */ @@ -1302,7 +1302,7 @@ clamp_position (GSequence *seq, * Returns the iterator at position @pos. If @pos is negative or larger * than the number of items in @seq, the end iterator is returned. * - * Return value: The #GSequenceIter at position @pos + * Returns: The #GSequenceIter at position @pos * * Since: 2.14 */ @@ -1353,7 +1353,7 @@ g_sequence_move (GSequenceIter *src, * * Returns whether @iter is the end iterator * - * Return value: Whether @iter is the end iterator + * Returns: Whether @iter is the end iterator * * Since: 2.14 */ @@ -1371,7 +1371,7 @@ g_sequence_iter_is_end (GSequenceIter *iter) * * Returns whether @iter is the begin iterator * - * Return value: whether @iter is the begin iterator + * Returns: whether @iter is the begin iterator * * Since: 2.14 */ @@ -1389,7 +1389,7 @@ g_sequence_iter_is_begin (GSequenceIter *iter) * * Returns the position of @iter * - * Return value: the position of @iter + * Returns: the position of @iter * * Since: 2.14 */ @@ -1408,7 +1408,7 @@ g_sequence_iter_get_position (GSequenceIter *iter) * Returns an iterator pointing to the next position after @iter. * If @iter is the end iterator, the end iterator is returned. * - * Return value: a #GSequenceIter pointing to the next position after @iter + * Returns: a #GSequenceIter pointing to the next position after @iter * * Since: 2.14 */ @@ -1427,7 +1427,7 @@ g_sequence_iter_next (GSequenceIter *iter) * Returns an iterator pointing to the previous position before @iter. * If @iter is the begin iterator, the begin iterator is returned. * - * Return value: a #GSequenceIter pointing to the previous position + * Returns: a #GSequenceIter pointing to the previous position * before @iter * * Since: 2.14 @@ -1451,7 +1451,7 @@ g_sequence_iter_prev (GSequenceIter *iter) * the begin iterator is returned. If @iter is closer than @delta positions * to the end of the sequence, the end iterator is returned. * - * Return value: a #GSequenceIter which is @delta positions away from @iter + * Returns: a #GSequenceIter which is @delta positions away from @iter * * Since: 2.14 */ diff --git a/glib/gshell.c b/glib/gshell.c index 289120697..1c39c330e 100644 --- a/glib/gshell.c +++ b/glib/gshell.c @@ -191,7 +191,7 @@ unquote_string_inplace (gchar* str, gchar** end, GError** err) * quoting style used is undefined (single or double quotes may be * used). * - * Return value: quoted string + * Returns: quoted string **/ gchar* g_shell_quote (const gchar *unquoted_string) @@ -257,7 +257,7 @@ g_shell_quote (const gchar *unquoted_string) * be escaped with backslash. Otherwise double quotes preserve things * literally. * - * Return value: an unquoted string + * Returns: an unquoted string **/ gchar* g_shell_unquote (const gchar *quoted_string, @@ -625,7 +625,7 @@ tokenize_command_line (const gchar *command_line, * literally. Possible errors are those from the #G_SHELL_ERROR * domain. Free the returned vector with g_strfreev(). * - * Return value: %TRUE on success, %FALSE if error set + * Returns: %TRUE on success, %FALSE if error set **/ gboolean g_shell_parse_argv (const gchar *command_line, diff --git a/glib/gspawn.c b/glib/gspawn.c index 495968a4c..58f8172a2 100644 --- a/glib/gspawn.c +++ b/glib/gspawn.c @@ -118,7 +118,7 @@ G_DEFINE_QUARK (g-spawn-exit-error-quark, g_spawn_exit_error) * process and not its identifier. Process handles and process identifiers * are different concepts on Windows. * - * Return value: %TRUE on success, %FALSE if error is set + * Returns: %TRUE on success, %FALSE if error is set **/ gboolean g_spawn_async (const gchar *working_directory, @@ -234,7 +234,7 @@ read_data (GString *str, * function for full details on the other parameters and details on * how these functions work on Windows. * - * Return value: %TRUE on success, %FALSE if an error was set + * Returns: %TRUE on success, %FALSE if an error was set */ gboolean g_spawn_sync (const gchar *working_directory, @@ -623,7 +623,7 @@ g_spawn_sync (const gchar *working_directory, * want to use gdk_spawn_on_screen_with_pipes() instead to ensure that * the spawned program opens its windows on the right screen. * - * Return value: %TRUE on success, %FALSE if an error was set + * Returns: %TRUE on success, %FALSE if an error was set */ gboolean g_spawn_async_with_pipes (const gchar *working_directory, @@ -699,7 +699,7 @@ g_spawn_async_with_pipes (const gchar *working_directory, * separator. You need to enclose such paths with single quotes, like * "'c:\\program files\\app\\app.exe' 'e:\\folder\\argument.txt'". * - * Return value: %TRUE on success, %FALSE if an error was set + * Returns: %TRUE on success, %FALSE if an error was set **/ gboolean g_spawn_command_line_sync (const gchar *command_line, @@ -748,7 +748,7 @@ g_spawn_command_line_sync (const gchar *command_line, * * The same concerns on Windows apply as for g_spawn_command_line_sync(). * - * Return value: %TRUE on success, %FALSE if error is set + * Returns: %TRUE on success, %FALSE if error is set **/ gboolean g_spawn_command_line_async (const gchar *command_line, diff --git a/glib/gstrfuncs.c b/glib/gstrfuncs.c index ab36b45db..58f8f9a40 100644 --- a/glib/gstrfuncs.c +++ b/glib/gstrfuncs.c @@ -458,7 +458,7 @@ g_strnfill (gsize length, * This is useful for concatenating multiple strings together * without having to repeatedly scan for the end. * - * Return value: a pointer to trailing nul byte. + * Returns: a pointer to trailing nul byte. **/ gchar * g_stpcpy (gchar *dest, @@ -609,7 +609,7 @@ g_strconcat (const gchar *string1, ...) * separated lists of values, since the commas may be interpreted as a decimal * point in some locales, causing unexpected results. * - * Return value: the #gdouble value. + * Returns: the #gdouble value. **/ gdouble g_strtod (const gchar *nptr, @@ -674,7 +674,7 @@ g_strtod (const gchar *nptr, * This function resets %errno before calling strtod() so that * you can reliably detect overflow and underflow. * - * Return value: the #gdouble value. + * Returns: the #gdouble value. */ gdouble g_ascii_strtod (const gchar *nptr, @@ -860,7 +860,7 @@ g_ascii_strtod (const gchar *nptr, * guaranteed that the size of the resulting string will never * be larger than @G_ASCII_DTOSTR_BUF_SIZE bytes. * - * Return value: The pointer to the buffer with the converted string. + * Returns: The pointer to the buffer with the converted string. **/ gchar * g_ascii_dtostr (gchar *buffer, @@ -889,7 +889,7 @@ g_ascii_dtostr (gchar *buffer, * If you just want to want to serialize the value into a * string, use g_ascii_dtostr(). * - * Return value: The pointer to the buffer with the converted string. + * Returns: The pointer to the buffer with the converted string. */ gchar * g_ascii_formatd (gchar *buffer, @@ -1142,7 +1142,7 @@ g_parse_long_long (const gchar *nptr, * If the string conversion fails, zero is returned, and @endptr returns * @nptr (if @endptr is non-%NULL). * - * Return value: the #guint64 value or zero on error. + * Returns: the #guint64 value or zero on error. * * Since: 2.2 */ @@ -1189,7 +1189,7 @@ g_ascii_strtoull (const gchar *nptr, * string conversion fails, zero is returned, and @endptr returns @nptr * (if @endptr is non-%NULL). * - * Return value: the #gint64 value or zero on error. + * Returns: the #gint64 value or zero on error. * * Since: 2.12 */ @@ -1448,7 +1448,7 @@ g_strlcat (gchar *dest, * * Converts all upper case ASCII letters to lower case ASCII letters. * - * Return value: a newly-allocated string, with all the upper case + * Returns: a newly-allocated string, with all the upper case * characters in @str converted to lower case, with semantics that * exactly match g_ascii_tolower(). (Note that this is unlike the * old g_strdown(), which modified the string in place.) @@ -1478,7 +1478,7 @@ g_ascii_strdown (const gchar *str, * * Converts all lower case ASCII letters to upper case ASCII letters. * - * Return value: a newly allocated string, with all the lower case + * Returns: a newly allocated string, with all the lower case * characters in @str converted to upper case, with semantics that * exactly match g_ascii_toupper(). (Note that this is unlike the * old g_strup(), which modified the string in place.) @@ -1530,7 +1530,7 @@ g_str_is_ascii (const gchar *str) * * Converts a string to lower case. * - * Return value: the string + * Returns: the string * * Deprecated:2.2: This function is totally broken for the reasons discussed * in the g_strncasecmp() docs - use g_ascii_strdown() or g_utf8_strdown() @@ -1561,7 +1561,7 @@ g_strdown (gchar *string) * * Converts a string to upper case. * - * Return value: the string + * Returns: the string * * Deprecated:2.2: This function is totally broken for the reasons * discussed in the g_strncasecmp() docs - use g_ascii_strup() @@ -1640,7 +1640,7 @@ g_strreverse (gchar *string) * don't call it on %EOF but no need to worry about casting to #guchar * before passing a possibly non-ASCII character in. * - * Return value: the result of converting @c to lower case. If @c is + * Returns: the result of converting @c to lower case. If @c is * not an ASCII upper case letter, @c is returned unchanged. */ gchar @@ -1663,7 +1663,7 @@ g_ascii_tolower (gchar c) * don't call it on %EOF but no need to worry about casting to #guchar * before passing a possibly non-ASCII character in. * - * Return value: the result of converting @c to upper case. If @c is not + * Returns: the result of converting @c to upper case. If @c is not * an ASCII lower case letter, @c is returned unchanged. */ gchar @@ -1680,7 +1680,7 @@ g_ascii_toupper (gchar c) * Differs from g_unichar_digit_value() because it takes a char, so * there's no worry about sign extension if characters are signed. * - * Return value: If @c is a decimal digit (according to g_ascii_isdigit()), + * Returns: If @c is a decimal digit (according to g_ascii_isdigit()), * its numeric value. Otherwise, -1. */ int @@ -1700,7 +1700,7 @@ g_ascii_digit_value (gchar c) * a char, so there's no worry about sign extension if characters * are signed. * - * Return value: If @c is a hex digit (according to g_ascii_isxdigit()), + * Returns: If @c is a hex digit (according to g_ascii_isxdigit()), * its numeric value. Otherwise, -1. */ int @@ -1734,7 +1734,7 @@ g_ascii_xdigit_value (gchar c) * * Both @s1 and @s2 must be non-%NULL. * - * Return value: 0 if the strings match, a negative value if @s1 < @s2, + * Returns: 0 if the strings match, a negative value if @s1 < @s2, * or a positive value if @s1 > @s2. */ gint @@ -1775,7 +1775,7 @@ g_ascii_strcasecmp (const gchar *s1, * function only on strings known to be in encodings where bytes * corresponding to ASCII letters always represent themselves. * - * Return value: 0 if the strings match, a negative value if @s1 < @s2, + * Returns: 0 if the strings match, a negative value if @s1 < @s2, * or a positive value if @s1 > @s2. */ gint @@ -1812,7 +1812,7 @@ g_ascii_strncasecmp (const gchar *s1, * A case-insensitive string comparison, corresponding to the standard * strcasecmp() function on platforms which support it. * - * Return value: 0 if the strings match, a negative value if @s1 < @s2, + * Returns: 0 if the strings match, a negative value if @s1 < @s2, * or a positive value if @s1 > @s2. * * Deprecated:2.2: See g_strncasecmp() for a discussion of why this @@ -1860,7 +1860,7 @@ g_strcasecmp (const gchar *s1, * to g_strcasecmp() except it only compares the first @n characters of * the strings. * - * Return value: 0 if the strings match, a negative value if @s1 < @s2, + * Returns: 0 if the strings match, a negative value if @s1 < @s2, * or a positive value if @s1 > @s2. * * Deprecated:2.2: The problem with g_strncasecmp() is that it does @@ -2253,7 +2253,7 @@ g_strchomp (gchar *string) * to represent empty elements, you'll need to check for the empty string * before calling g_strsplit(). * - * Return value: a newly-allocated %NULL-terminated array of strings. Use + * Returns: a newly-allocated %NULL-terminated array of strings. Use * g_strfreev() to free it. */ gchar** @@ -2338,7 +2338,7 @@ g_strsplit (const gchar *string, * Note that this function works on bytes not characters, so it can't be used * to delimit UTF-8 strings for anything but ASCII characters. * - * Return value: a newly-allocated %NULL-terminated array of strings. Use + * Returns: a newly-allocated %NULL-terminated array of strings. Use * g_strfreev() to free it. * * Since: 2.4 @@ -2436,7 +2436,7 @@ g_strfreev (gchar **str_array) * the array itself. g_strfreev() does this for you. If called * on a %NULL value, g_strdupv() simply returns %NULL. * - * Return value: a new %NULL-terminated array of strings. + * Returns: a new %NULL-terminated array of strings. */ gchar** g_strdupv (gchar **str_array) @@ -2601,7 +2601,7 @@ g_strjoin (const gchar *separator, * of the string @needle, limiting the length of the search * to @haystack_len. * - * Return value: a pointer to the found occurrence, or + * Returns: a pointer to the found occurrence, or * %NULL if not found. */ gchar * @@ -2653,7 +2653,7 @@ g_strstr_len (const gchar *haystack, * Searches the string @haystack for the last occurrence * of the string @needle. * - * Return value: a pointer to the found occurrence, or + * Returns: a pointer to the found occurrence, or * %NULL if not found. */ gchar * @@ -2704,7 +2704,7 @@ g_strrstr (const gchar *haystack, * of the string @needle, limiting the length of the search * to @haystack_len. * - * Return value: a pointer to the found occurrence, or + * Returns: a pointer to the found occurrence, or * %NULL if not found. */ gchar * @@ -2756,7 +2756,7 @@ g_strrstr_len (const gchar *haystack, * * Looks whether the string @str ends with @suffix. * - * Return value: %TRUE if @str end with @suffix, %FALSE otherwise. + * Returns: %TRUE if @str end with @suffix, %FALSE otherwise. * * Since: 2.2 */ @@ -2786,7 +2786,7 @@ g_str_has_suffix (const gchar *str, * * Looks whether the string @str begins with @prefix. * - * Return value: %TRUE if @str begins with @prefix, %FALSE otherwise. + * Returns: %TRUE if @str begins with @prefix, %FALSE otherwise. * * Since: 2.2 */ @@ -2816,7 +2816,7 @@ g_str_has_prefix (const gchar *str, * Returns the length of the given %NULL-terminated * string array @str_array. * - * Return value: length of @str_array. + * Returns: length of @str_array. * * Since: 2.6 */ diff --git a/glib/gstring.c b/glib/gstring.c index 2a0f25512..d9a5fdd43 100644 --- a/glib/gstring.c +++ b/glib/gstring.c @@ -383,7 +383,7 @@ g_string_truncate (GString *string, * of the newly added area are undefined. (However, as * always, string->str[string->len] will be a nul byte.) * - * Return value: @string + * Returns: @string */ GString * g_string_set_size (GString *string, @@ -653,7 +653,7 @@ g_string_append_c (GString *string, * Converts a Unicode character into UTF-8, and appends it * to the string. * - * Return value: @string + * Returns: @string */ GString * g_string_append_unichar (GString *string, @@ -738,7 +738,7 @@ g_string_prepend_c (GString *string, * Converts a Unicode character into UTF-8, and prepends it * to the string. * - * Return value: @string + * Returns: @string */ GString * g_string_prepend_unichar (GString *string, @@ -821,7 +821,7 @@ g_string_insert_c (GString *string, * Converts a Unicode character into UTF-8, and insert it * into the string at the given position. * - * Return value: @string + * Returns: @string */ GString * g_string_insert_unichar (GString *string, @@ -902,7 +902,7 @@ g_string_insert_unichar (GString *string, * * Overwrites part of a string, lengthening it if necessary. * - * Return value: @string + * Returns: @string * * Since: 2.14 */ @@ -925,7 +925,7 @@ g_string_overwrite (GString *string, * Overwrites part of a string, lengthening it if necessary. * This function will work with embedded nuls. * - * Return value: @string + * Returns: @string * * Since: 2.14 */ @@ -1008,7 +1008,7 @@ g_string_erase (GString *string, * * Converts all uppercase ASCII letters to lowercase ASCII letters. * - * Return value: passed-in @string pointer, with all the + * Returns: passed-in @string pointer, with all the * uppercase characters converted to lowercase in place, * with semantics that exactly match g_ascii_tolower(). */ @@ -1039,7 +1039,7 @@ g_string_ascii_down (GString *string) * * Converts all lowercase ASCII letters to uppercase ASCII letters. * - * Return value: passed-in @string pointer, with all the + * Returns: passed-in @string pointer, with all the * lowercase characters converted to uppercase in place, * with semantics that exactly match g_ascii_toupper(). */ @@ -1104,7 +1104,7 @@ g_string_down (GString *string) * * Converts a #GString to uppercase. * - * Return value: @string + * Returns: @string * * Deprecated:2.2: This function uses the locale-specific * toupper() function, which is almost never the right thing. diff --git a/glib/gstringchunk.c b/glib/gstringchunk.c index 41eb46ccb..16c98f0ed 100644 --- a/glib/gstringchunk.c +++ b/glib/gstringchunk.c @@ -271,7 +271,7 @@ g_string_chunk_insert_const (GStringChunk *chunk, * The characters in the returned string can be changed, if necessary, * though you should not change anything after the end of the string. * - * Return value: a pointer to the copy of @string within the #GStringChunk + * Returns: a pointer to the copy of @string within the #GStringChunk * * Since: 2.4 */ diff --git a/glib/gtestutils.h b/glib/gtestutils.h index 49986d228..95e6de18b 100644 --- a/glib/gtestutils.h +++ b/glib/gtestutils.h @@ -374,7 +374,7 @@ void g_test_log_msg_free (GTestLogMsg *tmsg); * * Specifies the prototype of fatal log handler functions. * - * Return value: %TRUE if the program should abort, %FALSE otherwise + * Returns: %TRUE if the program should abort, %FALSE otherwise * * Since: 2.22 */ diff --git a/glib/gthreadpool.c b/glib/gthreadpool.c index d8f1e7096..de9cedf00 100644 --- a/glib/gthreadpool.c +++ b/glib/gthreadpool.c @@ -453,7 +453,7 @@ g_thread_pool_start_thread (GRealThreadPool *pool, * errors. An error can only occur when @exclusive is set to %TRUE * and not all @max_threads threads could be created. * - * Return value: the new #GThreadPool + * Returns: the new #GThreadPool */ GThreadPool * g_thread_pool_new (GFunc func, @@ -531,7 +531,7 @@ g_thread_pool_new (GFunc func, * * Before version 2.32, this function did not return a success status. * - * Return value: %TRUE on success, %FALSE if an error occurred + * Returns: %TRUE on success, %FALSE if an error occurred */ gboolean g_thread_pool_push (GThreadPool *pool, @@ -596,7 +596,7 @@ g_thread_pool_push (GThreadPool *pool, * * Before version 2.32, this function did not return a success status. * - * Return value: %TRUE on success, %FALSE if an error occurred + * Returns: %TRUE on success, %FALSE if an error occurred */ gboolean g_thread_pool_set_max_threads (GThreadPool *pool, @@ -648,7 +648,7 @@ g_thread_pool_set_max_threads (GThreadPool *pool, * * Returns the maximal number of threads for @pool. * - * Return value: the maximal number of threads + * Returns: the maximal number of threads */ gint g_thread_pool_get_max_threads (GThreadPool *pool) @@ -674,7 +674,7 @@ g_thread_pool_get_max_threads (GThreadPool *pool) * * Returns the number of threads currently running in @pool. * - * Return value: the number of threads currently running + * Returns: the number of threads currently running */ guint g_thread_pool_get_num_threads (GThreadPool *pool) @@ -700,7 +700,7 @@ g_thread_pool_get_num_threads (GThreadPool *pool) * * Returns the number of tasks still unprocessed in @pool. * - * Return value: the number of unprocessed tasks + * Returns: the number of unprocessed tasks */ guint g_thread_pool_unprocessed (GThreadPool *pool) @@ -870,7 +870,7 @@ g_thread_pool_set_max_unused_threads (gint max_threads) * * Returns the maximal allowed number of unused threads. * - * Return value: the maximal number of unused threads + * Returns: the maximal number of unused threads */ gint g_thread_pool_get_max_unused_threads (void) @@ -883,7 +883,7 @@ g_thread_pool_get_max_unused_threads (void) * * Returns the number of currently unused threads. * - * Return value: the number of currently unused threads + * Returns: the number of currently unused threads */ guint g_thread_pool_get_num_unused_threads (void) @@ -1008,7 +1008,7 @@ g_thread_pool_set_max_idle_time (guint interval) * If this function returns 0, threads waiting in the thread * pool for new work are not stopped. * - * Return value: the maximum @interval (milliseconds) to wait + * Returns: the maximum @interval (milliseconds) to wait * for new tasks in the thread pool before stopping the * thread * diff --git a/glib/gtimer.c b/glib/gtimer.c index b600a57a6..4d24caed2 100644 --- a/glib/gtimer.c +++ b/glib/gtimer.c @@ -344,7 +344,7 @@ mktime_utc (struct tm *tm) * zone indicator. (In the absence of any time zone indication, the * timestamp is assumed to be in local time.) * - * Return value: %TRUE if the conversion was successful. + * Returns: %TRUE if the conversion was successful. * * Since: 2.12 */ @@ -491,7 +491,7 @@ g_time_val_from_iso8601 (const gchar *iso_date, * Use g_date_time_format() or g_strdup_printf() if a different * variation of ISO 8601 format is required. * - * Return value: a newly allocated string containing an ISO 8601 date + * Returns: a newly allocated string containing an ISO 8601 date * * Since: 2.12 */ diff --git a/glib/gtree.c b/glib/gtree.c index 3ea375c02..7fb41c24f 100644 --- a/glib/gtree.c +++ b/glib/gtree.c @@ -156,7 +156,7 @@ g_tree_node_new (gpointer key, * * Creates a new #GTree. * - * Return value: a newly allocated #GTree + * Returns: a newly allocated #GTree */ GTree * g_tree_new (GCompareFunc key_compare_func) @@ -175,7 +175,7 @@ g_tree_new (GCompareFunc key_compare_func) * Creates a new #GTree with a comparison function that accepts user data. * See g_tree_new() for more details. * - * Return value: a newly allocated #GTree + * Returns: a newly allocated #GTree */ GTree * g_tree_new_with_data (GCompareDataFunc key_compare_func, @@ -202,7 +202,7 @@ g_tree_new_with_data (GCompareDataFunc key_compare_func, * to free the memory allocated for the key and value that get called when * removing the entry from the #GTree. * - * Return value: a newly allocated #GTree + * Returns: a newly allocated #GTree */ GTree * g_tree_new_full (GCompareDataFunc key_compare_func, @@ -305,7 +305,7 @@ g_tree_remove_all (GTree *tree) * * It is safe to call this function from any thread. * - * Return value: the passed in #GTree + * Returns: the passed in #GTree * * Since: 2.22 */ @@ -833,7 +833,7 @@ g_tree_remove_internal (GTree *tree, * automatically balanced as key/value pairs are added, key lookup * is O(log n) (where n is the number of key/value pairs in the tree). * - * Return value: the value corresponding to the key, or %NULL + * Returns: the value corresponding to the key, or %NULL * if the key was not found */ gpointer @@ -861,7 +861,7 @@ g_tree_lookup (GTree *tree, * allocated for the original key, for example before calling * g_tree_remove(). * - * Return value: %TRUE if the key was found in the #GTree + * Returns: %TRUE if the key was found in the #GTree */ gboolean g_tree_lookup_extended (GTree *tree, @@ -1002,7 +1002,7 @@ g_tree_traverse (GTree *tree, * @search_func returns 1, searching will proceed among the key/value * pairs that have a larger key. * - * Return value: the value corresponding to the found key, or %NULL + * Returns: the value corresponding to the found key, or %NULL * if the key was not found */ gpointer @@ -1028,7 +1028,7 @@ g_tree_search (GTree *tree, * If the #GTree contains only one root node the height is 1. * If the root node has children the height is 2, etc. * - * Return value: the height of @tree + * Returns: the height of @tree */ gint g_tree_height (GTree *tree) @@ -1061,7 +1061,7 @@ g_tree_height (GTree *tree) * * Gets the number of nodes in a #GTree. * - * Return value: the number of nodes in @tree + * Returns: the number of nodes in @tree */ gint g_tree_nnodes (GTree *tree) diff --git a/glib/gunibreak.c b/glib/gunibreak.c index 266e6b17e..8fcd4de36 100644 --- a/glib/gunibreak.c +++ b/glib/gunibreak.c @@ -51,7 +51,7 @@ * resolution algorithms and normally you would use a function such * as pango_break() instead of caring about break types yourself. * - * Return value: the break type of @c + * Returns: the break type of @c **/ GUnicodeBreakType g_unichar_break_type (gunichar c) diff --git a/glib/gunicollate.c b/glib/gunicollate.c index 3aa94ffca..f9d8b3df0 100644 --- a/glib/gunicollate.c +++ b/glib/gunicollate.c @@ -71,7 +71,7 @@ msc_strxfrm_wrapper (char *string1, * compare the keys with strcmp() when sorting instead of sorting * the original strings. * - * Return value: < 0 if @str1 compares before @str2, + * Returns: < 0 if @str1 compares before @str2, * 0 if they compare equal, > 0 if @str1 compares after @str2. **/ gint @@ -365,7 +365,7 @@ carbon_collate_key_for_filename (const gchar *str, * * Note that this function depends on the [current locale][setlocale]. * - * Return value: a newly allocated string. This string should + * Returns: a newly allocated string. This string should * be freed with g_free() when you are done with it. **/ gchar * @@ -492,7 +492,7 @@ g_utf8_collate_key (const gchar *str, * * Note that this function depends on the [current locale][setlocale]. * - * Return value: a newly allocated string. This string should + * Returns: a newly allocated string. This string should * be freed with g_free() when you are done with it. * * Since: 2.8 diff --git a/glib/gunidecomp.c b/glib/gunidecomp.c index 998798ae7..44943c84f 100644 --- a/glib/gunidecomp.c +++ b/glib/gunidecomp.c @@ -75,7 +75,7 @@ * * Determines the canonical combining class of a Unicode character. * - * Return value: the combining class of the character + * Returns: the combining class of the character * * Since: 2.14 **/ @@ -224,7 +224,7 @@ find_decomposition (gunichar ch, * * Computes the canonical decomposition of a Unicode character. * - * Return value: a newly allocated string of Unicode characters. + * Returns: a newly allocated string of Unicode characters. * @result_len is set to the resulting length of the string. * * Deprecated: 2.30: Use the more flexible g_unichar_fully_decompose() @@ -522,7 +522,7 @@ _g_utf8_normalize_wc (const gchar *str, * a legacy encoding or pass it to a system with * less capable Unicode handling. * - * Return value: a newly allocated string, that is the + * Returns: a newly allocated string, that is the * normalized form of @str, or %NULL if @str is not * valid UTF-8. **/ @@ -709,7 +709,7 @@ g_unichar_compose (gunichar a, * [UAX#15](http://unicode.org/reports/tr15/) * for details. * - * Return value: the length of the full decomposition. + * Returns: the length of the full decomposition. * * Since: 2.30 **/ diff --git a/glib/guniprop.c b/glib/guniprop.c index fab9b756a..969cdc414 100644 --- a/glib/guniprop.c +++ b/glib/guniprop.c @@ -102,7 +102,7 @@ * Given some UTF-8 text, obtain a character value * with g_utf8_get_char(). * - * Return value: %TRUE if @c is an alphanumeric character + * Returns: %TRUE if @c is an alphanumeric character **/ gboolean g_unichar_isalnum (gunichar c) @@ -118,7 +118,7 @@ g_unichar_isalnum (gunichar c) * Given some UTF-8 text, obtain a character value with * g_utf8_get_char(). * - * Return value: %TRUE if @c is an alphabetic character + * Returns: %TRUE if @c is an alphabetic character **/ gboolean g_unichar_isalpha (gunichar c) @@ -135,7 +135,7 @@ g_unichar_isalpha (gunichar c) * Given some UTF-8 text, obtain a character value with * g_utf8_get_char(). * - * Return value: %TRUE if @c is a control character + * Returns: %TRUE if @c is a control character **/ gboolean g_unichar_iscntrl (gunichar c) @@ -151,7 +151,7 @@ g_unichar_iscntrl (gunichar c) * covers ASCII 0-9 and also digits in other languages/scripts. Given * some UTF-8 text, obtain a character value with g_utf8_get_char(). * - * Return value: %TRUE if @c is a digit + * Returns: %TRUE if @c is a digit **/ gboolean g_unichar_isdigit (gunichar c) @@ -170,7 +170,7 @@ g_unichar_isdigit (gunichar c) * spaces. Given some UTF-8 text, obtain a character value with * g_utf8_get_char(). * - * Return value: %TRUE if @c is printable unless it's a space + * Returns: %TRUE if @c is printable unless it's a space **/ gboolean g_unichar_isgraph (gunichar c) @@ -192,7 +192,7 @@ g_unichar_isgraph (gunichar c) * Given some UTF-8 text, obtain a character value with * g_utf8_get_char(). * - * Return value: %TRUE if @c is a lowercase letter + * Returns: %TRUE if @c is a lowercase letter **/ gboolean g_unichar_islower (gunichar c) @@ -210,7 +210,7 @@ g_unichar_islower (gunichar c) * Given some UTF-8 text, obtain a character value with * g_utf8_get_char(). * - * Return value: %TRUE if @c is printable + * Returns: %TRUE if @c is printable **/ gboolean g_unichar_isprint (gunichar c) @@ -231,7 +231,7 @@ g_unichar_isprint (gunichar c) * Given some UTF-8 text, obtain a character value with * g_utf8_get_char(). * - * Return value: %TRUE if @c is a punctuation or symbol character + * Returns: %TRUE if @c is a punctuation or symbol character **/ gboolean g_unichar_ispunct (gunichar c) @@ -263,7 +263,7 @@ g_unichar_ispunct (gunichar c) * Pango or equivalent to get word breaking right, the algorithm * is fairly complex.) * - * Return value: %TRUE if @c is a space character + * Returns: %TRUE if @c is a space character **/ gboolean g_unichar_isspace (gunichar c) @@ -304,7 +304,7 @@ g_unichar_isspace (gunichar c) * for writing most European languages as well as many non-Latin * scripts. * - * Return value: %TRUE if @c is a mark character + * Returns: %TRUE if @c is a mark character * * Since: 2.14 **/ @@ -320,7 +320,7 @@ g_unichar_ismark (gunichar c) * * Determines if a character is uppercase. * - * Return value: %TRUE if @c is an uppercase character + * Returns: %TRUE if @c is an uppercase character **/ gboolean g_unichar_isupper (gunichar c) @@ -339,7 +339,7 @@ g_unichar_isupper (gunichar c) * first letter is capitalized. The titlecase form of the DZ * digraph is U+01F2 LATIN CAPITAL LETTTER D WITH SMALL LETTER Z. * - * Return value: %TRUE if the character is titlecase + * Returns: %TRUE if the character is titlecase **/ gboolean g_unichar_istitle (gunichar c) @@ -357,7 +357,7 @@ g_unichar_istitle (gunichar c) * * Determines if a character is a hexidecimal digit. * - * Return value: %TRUE if the character is a hexadecimal digit + * Returns: %TRUE if the character is a hexadecimal digit **/ gboolean g_unichar_isxdigit (gunichar c) @@ -374,7 +374,7 @@ g_unichar_isxdigit (gunichar c) * Determines if a given character is assigned in the Unicode * standard. * - * Return value: %TRUE if the character has an assigned value + * Returns: %TRUE if the character has an assigned value **/ gboolean g_unichar_isdefined (gunichar c) @@ -399,7 +399,7 @@ g_unichar_isdefined (gunichar c) * when displayed on a grid display (terminals). However, note that not all * terminals support zero-width rendering of zero-width marks. * - * Return value: %TRUE if the character has zero width + * Returns: %TRUE if the character has zero width * * Since: 2.14 **/ @@ -459,7 +459,7 @@ interval_compare (const void *key, const void *elt) * Determines if a character is typically rendered in a double-width * cell. * - * Return value: %TRUE if the character is wide + * Returns: %TRUE if the character is wide **/ gboolean g_unichar_iswide (gunichar c) @@ -500,7 +500,7 @@ g_unichar_iswide (gunichar c) * this test, but not the other way around. Note that some characters may * pas both this test and g_unichar_iszerowidth(). * - * Return value: %TRUE if the character is wide in legacy East Asian locales + * Returns: %TRUE if the character is wide in legacy East Asian locales * * Since: 2.12 */ @@ -572,7 +572,7 @@ g_unichar_iswide_cjk (gunichar c) * * Converts a character to uppercase. * - * Return value: the result of converting @c to uppercase. + * Returns: the result of converting @c to uppercase. * If @c is not an lowercase or titlecase character, * or has no upper case equivalent @c is returned unchanged. **/ @@ -612,7 +612,7 @@ g_unichar_toupper (gunichar c) * * Converts a character to lower case. * - * Return value: the result of converting @c to lower case. + * Returns: the result of converting @c to lower case. * If @c is not an upperlower or titlecase character, * or has no lowercase equivalent @c is returned unchanged. **/ @@ -653,7 +653,7 @@ g_unichar_tolower (gunichar c) * * Converts a character to the titlecase. * - * Return value: the result of converting @c to titlecase. + * Returns: the result of converting @c to titlecase. * If @c is not an uppercase or lowercase character, * @c is returned unchanged. **/ @@ -681,7 +681,7 @@ g_unichar_totitle (gunichar c) * Determines the numeric value of a character as a decimal * digit. * - * Return value: If @c is a decimal digit (according to + * Returns: If @c is a decimal digit (according to * g_unichar_isdigit()), its numeric value. Otherwise, -1. **/ int @@ -699,7 +699,7 @@ g_unichar_digit_value (gunichar c) * Determines the numeric value of a character as a hexidecimal * digit. * - * Return value: If @c is a hex digit (according to + * Returns: If @c is a hex digit (according to * g_unichar_isxdigit()), its numeric value. Otherwise, -1. **/ int @@ -720,7 +720,7 @@ g_unichar_xdigit_value (gunichar c) * * Classifies a Unicode character by type. * - * Return value: the type of the character. + * Returns: the type of the character. **/ GUnicodeType g_unichar_type (gunichar c) @@ -948,7 +948,7 @@ real_toupper (const gchar *str, * characters in the string increasing. (For instance, the * German ess-zet will be changed to SS.) * - * Return value: a newly allocated string, with all characters + * Returns: a newly allocated string, with all characters * converted to uppercase. **/ gchar * @@ -1136,7 +1136,7 @@ real_tolower (const gchar *str, * on the current locale, and may result in the number of * characters in the string changing. * - * Return value: a newly allocated string, with all characters + * Returns: a newly allocated string, with all characters * converted to lowercase. **/ gchar * @@ -1179,7 +1179,7 @@ g_utf8_strdown (const gchar *str, * takes case sensitivity into account. GLib does not currently * provide such a function. * - * Return value: a newly allocated string, that is a + * Returns: a newly allocated string, that is a * case independent form of @str. **/ gchar * @@ -1244,7 +1244,7 @@ g_utf8_casefold (const gchar *str, * glyph and @mirrored_ch is set, it puts that character in the address * pointed to by @mirrored_ch. Otherwise the original character is put. * - * Return value: %TRUE if @ch has a mirrored character, %FALSE otherwise + * Returns: %TRUE if @ch has a mirrored character, %FALSE otherwise * * Since: 2.4 **/ @@ -1304,7 +1304,7 @@ g_unichar_get_script_bsearch (gunichar ch) * This function is equivalent to pango_script_for_unichar() and the * two are interchangeable. * - * Return value: the #GUnicodeScript for the character. + * Returns: the #GUnicodeScript for the character. * * Since: 2.14 */ @@ -1458,7 +1458,7 @@ static const guint32 iso15924_tags[] = * [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, + * Returns: the ISO 15924 code for @script, encoded as an integer, * of zero if @script is %G_UNICODE_SCRIPT_INVALID_CODE or * ISO 15924 code 'Zzzz' (script code for UNKNOWN) if @script is not understood. * @@ -1490,7 +1490,7 @@ g_unicode_script_to_iso15924 (GUnicodeScript script) * [Codes for the representation of names of scripts](http://unicode.org/iso15924/codelists.html) * for details. * - * Return value: the Unicode script for @iso15924, or + * Returns: the Unicode script for @iso15924, or * of %G_UNICODE_SCRIPT_INVALID_CODE if @iso15924 is zero and * %G_UNICODE_SCRIPT_UNKNOWN if @iso15924 is unknown. * diff --git a/glib/gutf8.c b/glib/gutf8.c index b866349f2..579c017f7 100644 --- a/glib/gutf8.c +++ b/glib/gutf8.c @@ -136,7 +136,7 @@ const gchar * const g_utf8_skip = utf8_skip_data; * is made to see if the character found is actually valid other than * it starts with an appropriate byte. * - * Return value: a pointer to the found character or %NULL. + * Returns: a pointer to the found character or %NULL. */ gchar * g_utf8_find_prev_char (const char *str, @@ -162,7 +162,7 @@ g_utf8_find_prev_char (const char *str, * is made to see if the character found is actually valid other than * it starts with an appropriate byte. * - * Return value: a pointer to the found character or %NULL + * Returns: a pointer to the found character or %NULL */ gchar * g_utf8_find_next_char (const gchar *p, @@ -191,7 +191,7 @@ g_utf8_find_next_char (const gchar *p, * it starts with an appropriate byte. If @p might be the first * character of the string, you must use g_utf8_find_prev_char() instead. * - * Return value: a pointer to the found character + * Returns: a pointer to the found character */ gchar * g_utf8_prev_char (const gchar *p) @@ -217,7 +217,7 @@ g_utf8_prev_char (const gchar *p) * the terminating nul character. If the @max'th byte falls in the * middle of a character, the last (partial) character is not counted. * - * Return value: the length of the string in characters + * Returns: the length of the string in characters */ glong g_utf8_strlen (const gchar *p, @@ -300,7 +300,7 @@ g_utf8_substring (const gchar *str, * valid Unicode characters, you should use g_utf8_get_char_validated() * instead. * - * Return value: the resulting character + * Returns: the resulting character */ gunichar g_utf8_get_char (const gchar *p) @@ -336,7 +336,7 @@ g_utf8_get_char (const gchar *p) * This limitation exists as this function is called frequently during * text rendering and therefore has to be as fast as possible. * - * Return value: the resulting pointer + * Returns: the resulting pointer */ gchar * g_utf8_offset_to_pointer (const gchar *str, @@ -380,7 +380,7 @@ g_utf8_offset_to_pointer (const gchar *str, * Since 2.10, this function allows @pos to be before @str, and returns * a negative offset in this case. * - * Return value: the resulting character offset + * Returns: the resulting character offset */ glong g_utf8_pointer_to_offset (const gchar *str, @@ -413,7 +413,7 @@ g_utf8_pointer_to_offset (const gchar *str, * must be valid UTF-8 encoded text. (Use g_utf8_validate() on all * text before trying to use UTF-8 utility functions with it.) * - * Return value: @dest + * Returns: @dest */ gchar * g_utf8_strncpy (gchar *dest, @@ -442,7 +442,7 @@ g_utf8_strncpy (gchar *dest, * * Converts a single character to UTF-8. * - * Return value: number of bytes written + * Returns: number of bytes written */ int g_unichar_to_utf8 (gunichar c, @@ -507,7 +507,7 @@ g_unichar_to_utf8 (gunichar c, * in a UTF-8 encoded string, while limiting the search to @len bytes. * If @len is -1, allow unbounded search. * - * Return value: %NULL if the string does not contain the character, + * Returns: %NULL if the string does not contain the character, * otherwise, a pointer to the start of the leftmost occurrence * of the character in the string. */ @@ -535,7 +535,7 @@ g_utf8_strchr (const char *p, * in a UTF-8 encoded string, while limiting the search to @len bytes. * If @len is -1, allow unbounded search. * - * Return value: %NULL if the string does not contain the character, + * Returns: %NULL if the string does not contain the character, * otherwise, a pointer to the start of the rightmost occurrence * of the character in the string. */ @@ -652,7 +652,7 @@ g_utf8_get_char_extended (const gchar *p, * such as characters that are out of the range of Unicode, and for * overlong encodings of valid characters. * - * Return value: the resulting character. If @p points to a partial + * Returns: the resulting character. If @p points to a partial * sequence at the end of a string that could begin a valid * character (or if @max_len is zero), returns (gunichar)-2; * otherwise, if @p does not point to a valid UTF-8 encoded @@ -691,7 +691,7 @@ g_utf8_get_char_validated (const gchar *p, * but does no error checking on the input. A trailing 0 character * will be added to the string after the converted text. * - * Return value: a pointer to a newly allocated UCS-4 string. + * Returns: a pointer to a newly allocated UCS-4 string. * This value must be freed with g_free(). */ gunichar * @@ -802,7 +802,7 @@ try_malloc_n (gsize n_blocks, gsize n_block_bytes, GError **error) * representation as UCS-4. A trailing 0 character will be added to the * string after the converted text. * - * Return value: a pointer to a newly allocated UCS-4 string. + * Returns: a pointer to a newly allocated UCS-4 string. * This value must be freed with g_free(). If an error occurs, * %NULL will be returned and @error set. */ @@ -883,7 +883,7 @@ g_utf8_to_ucs4 (const gchar *str, * Convert a string from a 32-bit fixed width representation as UCS-4. * to UTF-8. The result will be terminated with a 0 byte. * - * Return value: a pointer to a newly allocated UTF-8 string. + * Returns: a pointer to a newly allocated UTF-8 string. * This value must be freed with g_free(). If an error occurs, * %NULL will be returned and @error set. In that case, @items_read * will be set to the position of the first invalid input character. @@ -969,7 +969,7 @@ g_ucs4_to_utf8 (const gunichar *str, * be correctly interpreted as UTF-16, i.e. it doesn't contain * things unpaired surrogates. * - * Return value: a pointer to a newly allocated UTF-8 string. + * Returns: a pointer to a newly allocated UTF-8 string. * This value must be freed with g_free(). If an error occurs, * %NULL will be returned and @error set. **/ @@ -1113,7 +1113,7 @@ g_utf16_to_utf8 (const gunichar2 *str, * Convert a string from UTF-16 to UCS-4. The result will be * nul-terminated. * - * Return value: a pointer to a newly allocated UCS-4 string. + * Returns: a pointer to a newly allocated UCS-4 string. * This value must be freed with g_free(). If an error occurs, * %NULL will be returned and @error set. */ @@ -1251,7 +1251,7 @@ g_utf16_to_ucs4 (const gunichar2 *str, * Convert a string from UTF-8 to UTF-16. A 0 character will be * added to the result after the converted text. * - * Return value: a pointer to a newly allocated UTF-16 string. + * Returns: a pointer to a newly allocated UTF-16 string. * This value must be freed with g_free(). If an error occurs, * %NULL will be returned and @error set. */ @@ -1367,7 +1367,7 @@ g_utf8_to_utf16 (const gchar *str, * Convert a string from UCS-4 to UTF-16. A 0 character will be * added to the result after the converted text. * - * Return value: a pointer to a newly allocated UTF-16 string. + * Returns: a pointer to a newly allocated UTF-16 string. * This value must be freed with g_free(). If an error occurs, * %NULL will be returned and @error set. */ @@ -1615,7 +1615,7 @@ fast_validate_len (const char *str, * or the network should be checked with g_utf8_validate() before * doing anything else with it. * - * Return value: %TRUE if the text was valid UTF-8 + * Returns: %TRUE if the text was valid UTF-8 */ gboolean g_utf8_validate (const char *str, @@ -1648,7 +1648,7 @@ g_utf8_validate (const char *str, * integer values of @ch will not be valid. 0 is considered a valid * character, though it's normally a string terminator. * - * Return value: %TRUE if @ch is a valid Unicode character + * Returns: %TRUE if @ch is a valid Unicode character **/ gboolean g_unichar_validate (gunichar ch) diff --git a/glib/gutils.c b/glib/gutils.c index 387b8bec7..526ccb22b 100644 --- a/glib/gutils.c +++ b/glib/gutils.c @@ -323,7 +323,7 @@ g_find_program_in_path (const gchar *program) * the program is found, the return value contains the full name * including the type suffix. * - * Return value: a newly-allocated string with the absolute path, or %NULL + * Returns: a newly-allocated string with the absolute path, or %NULL **/ #ifdef G_OS_WIN32 static gchar * @@ -1075,7 +1075,7 @@ static gchar *g_application_name = NULL; * g_get_prgname() (which may be %NULL if g_set_prgname() has also not * been called). * - * Return value: human-readable application name. may return %NULL + * Returns: human-readable application name. may return %NULL * * Since: 2.2 **/ @@ -1144,7 +1144,7 @@ g_set_application_name (const gchar *application_name) * CSIDL_LOCAL_APPDATA. Note that on Windows it thus is the same as * what g_get_user_config_dir() returns. * - * Return value: a string owned by GLib that must not be modified + * Returns: a string owned by GLib that must not be modified * or freed. * Since: 2.6 **/ @@ -1230,7 +1230,7 @@ g_init_user_config_dir (void) * CSIDL_LOCAL_APPDATA. Note that on Windows it thus is the same as * what g_get_user_data_dir() returns. * - * Return value: a string owned by GLib that must not be modified + * Returns: a string owned by GLib that must not be modified * or freed. * Since: 2.6 **/ @@ -1262,7 +1262,7 @@ g_get_user_config_dir (void) * C:\Documents and Settings\username\Local Settings\Temporary Internet Files. * See documentation for CSIDL_INTERNET_CACHE. * - * Return value: a string owned by GLib that must not be modified + * Returns: a string owned by GLib that must not be modified * or freed. * Since: 2.6 **/ @@ -1704,7 +1704,7 @@ g_reload_user_special_dirs_cache (void) * of the special directory without requiring the session to restart; GLib * will not reflect any change once the special directories are loaded. * - * Return value: the path to the specified special directory, or %NULL + * Returns: the path to the specified special directory, or %NULL * if the logical id was not found. The returned string is owned by * GLib and should not be modified or freed. * @@ -1921,7 +1921,7 @@ g_win32_get_system_data_dirs_for_module (void (*address_of_function)(void)) * Note that on Windows the returned list can vary depending on where * this function is called. * - * Return value: (array zero-terminated=1) (transfer none): a %NULL-terminated array of strings owned by GLib that must + * Returns: (array zero-terminated=1) (transfer none): a %NULL-terminated array of strings owned by GLib that must * not be modified or freed. * Since: 2.6 **/ @@ -1973,7 +1973,7 @@ g_get_system_data_dirs (void) * of clip art, or a log file in the CSIDL_COMMON_APPDATA folder. * This information will not roam and is available to anyone using the computer. * - * Return value: (array zero-terminated=1) (transfer none): a %NULL-terminated array of strings owned by GLib that must + * Returns: (array zero-terminated=1) (transfer none): a %NULL-terminated array of strings owned by GLib that must * not be modified or freed. * Since: 2.6 **/ diff --git a/glib/gversion.c b/glib/gversion.c index d1c30bf62..b8283db45 100644 --- a/glib/gversion.c +++ b/glib/gversion.c @@ -118,7 +118,7 @@ const guint glib_binary_age = GLIB_BINARY_AGE; * version @required_major.required_minor.@required_micro * (same major version.) * - * Return value: %NULL if the GLib library is compatible with the + * Returns: %NULL if the GLib library is compatible with the * given version, or a string describing the version mismatch. * The returned string is owned by GLib and must not be modified * or freed. diff --git a/glib/gwin32.c b/glib/gwin32.c index fa2ba3e28..ea26bf410 100644 --- a/glib/gwin32.c +++ b/glib/gwin32.c @@ -547,7 +547,7 @@ g_win32_get_windows_version (void) * The return value is dynamically allocated and should be freed with * g_free() when no longer needed. * - * Return value: The converted filename, or %NULL on conversion + * Returns: The converted filename, or %NULL on conversion * failure and lack of short names. * * Since: 2.8 diff --git a/gobject/gbinding.c b/gobject/gbinding.c index 0269d572e..0e17b898b 100644 --- a/gobject/gbinding.c +++ b/gobject/gbinding.c @@ -706,7 +706,7 @@ g_binding_init (GBinding *binding) * * Retrieves the flags passed when constructing the #GBinding. * - * Return value: the #GBindingFlags used by the #GBinding + * Returns: the #GBindingFlags used by the #GBinding * * Since: 2.26 */ @@ -724,7 +724,7 @@ g_binding_get_flags (GBinding *binding) * * Retrieves the #GObject instance used as the source of the binding. * - * Return value: (transfer none): the source #GObject + * Returns: (transfer none): the source #GObject * * Since: 2.26 */ @@ -742,7 +742,7 @@ g_binding_get_source (GBinding *binding) * * Retrieves the #GObject instance used as the target of the binding. * - * Return value: (transfer none): the target #GObject + * Returns: (transfer none): the target #GObject * * Since: 2.26 */ @@ -761,7 +761,7 @@ g_binding_get_target (GBinding *binding) * Retrieves the name of the property of #GBinding:source used as the source * of the binding. * - * Return value: the name of the source property + * Returns: the name of the source property * * Since: 2.26 */ @@ -780,7 +780,7 @@ g_binding_get_source_property (GBinding *binding) * Retrieves the name of the property of #GBinding:target used as the target * of the binding. * - * Return value: the name of the target property + * Returns: the name of the target property * * Since: 2.26 */ @@ -854,7 +854,7 @@ g_binding_unbind (GBinding *binding) * for each transformation function, please use * g_object_bind_property_with_closures() instead. * - * Return value: (transfer none): the #GBinding instance representing the + * Returns: (transfer none): the #GBinding instance representing the * binding between the two #GObject instances. The binding is released * whenever the #GBinding reference count reaches zero. * @@ -1035,7 +1035,7 @@ g_object_bind_property_full (gpointer source, * * A #GObject can have multiple bindings. * - * Return value: (transfer none): the #GBinding instance representing the + * Returns: (transfer none): the #GBinding instance representing the * binding between the two #GObject instances. The binding is released * whenever the #GBinding reference count reaches zero. * @@ -1186,7 +1186,7 @@ bind_with_closures_free_func (gpointer data) * * Rename to: g_object_bind_property_full * - * Return value: (transfer none): the #GBinding instance representing the + * Returns: (transfer none): the #GBinding instance representing the * binding between the two #GObject instances. The binding is released * whenever the #GBinding reference count reaches zero. * diff --git a/gobject/gbinding.h b/gobject/gbinding.h index 4b343e93b..e4e56d9c5 100644 --- a/gobject/gbinding.h +++ b/gobject/gbinding.h @@ -60,7 +60,7 @@ typedef struct _GBinding GBinding; * @transform_from function of a %G_BINDING_BIDIRECTIONAL binding, * then those roles are reversed. * - * Return value: %TRUE if the transformation was successful, and %FALSE + * Returns: %TRUE if the transformation was successful, and %FALSE * otherwise * * Since: 2.26