Instead of "Return value:".
* 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
**/
* 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
**/
* 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
**/
* 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
**/
* 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
* 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
*/
*
* 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 *
* 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 *
* 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,
* 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)
* 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)
*
* Converts @mask back to its corresponding string form.
*
- * Return value: a string corresponding to @mask.
+ * Returns: a string corresponding to @mask.
*
* Since: 2.32
*/
*
* 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
*/
*
* Gets @mask's base address
*
- * Return value: (transfer none): @mask's base address
+ * Returns: (transfer none): @mask's base address
*
* Since: 2.32
*/
*
* Gets @mask's length
*
- * Return value: @mask's length
+ * Returns: @mask's length
*
* Since: 2.32
*/
*
* 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
*
* 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
*/
* 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
*/
* 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
*/
* 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
* 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
* 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
*
* 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,
* 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,
*
* 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,
* 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,
* 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,
* 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)
*
* Gets the GIO Error Quark.
*
- * Return value: a #GQuark.
+ * Returns: a #GQuark.
**/
G_DEFINE_QUARK (g-io-error-quark, g_io_error)
* 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.
*/
* 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.
*/
* 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
*/
* 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
*/
* 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,
* 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
*/
* 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
*/
* 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
*/
* 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
*/
*
* 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
*/
*
* 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
*/
* 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
*/
* 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
*/
* 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,
* @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
*/
*
* Gets @srv's service name (eg, "ldap").
*
- * Return value: @srv's service name
+ * Returns: @srv's service name
*
* Since: 2.22
*/
*
* Gets @srv's protocol name (eg, "tcp").
*
- * Return value: @srv's protocol name
+ * Returns: @srv's protocol name
*
* Since: 2.22
*/
* 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
*/
* 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
*/
*
* 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,
* 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,
*
* 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,
*
* 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,
* #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,
* 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,
* 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,
* 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,
* 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
* 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
* 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
*/
* 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
*/
* 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
*/
* 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
* 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.
*
*
* See g_proxy_connect().
*
- * Return value: (transfer full): a #GIOStream.
+ * Returns: (transfer full): a #GIOStream.
*
* Since: 2.26
*/
* #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
*/
*
* Gets the default #GProxyResolver for the system.
*
- * Return value: (transfer none): the default #GProxyResolver.
+ * Returns: (transfer none): the default #GProxyResolver.
*
* Since: 2.26
*/
* 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
*/
* 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().
*
* 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().
*
* 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
*/
* 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.)
* 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.
*
* 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
* 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
* 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.)
*
* 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
* 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.)
*
* 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.)
*
*
* Gets the #GResolver Error Quark.
*
- * Return value: a #GQuark.
+ * Returns: a #GQuark.
*
* Since: 2.22
*/
*
* Gets the #GResource Error Quark.
*
- * Return value: a #GQuark
+ * Returns: a #GQuark
*
* Since: 2.32
*/
* 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
**/
* 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
**/
* [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
**/
* 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.
*/
* 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.
*/
*
* Creates a #GSocketAddressEnumerator for @connectable.
*
- * Return value: (transfer full): a new #GSocketAddressEnumerator.
+ * Returns: (transfer full): a new #GSocketAddressEnumerator.
*
* Since: 2.22
*/
* 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
*/
* 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
*/
*
* Copies @target
*
- * Return value: a copy of @target
+ * Returns: a copy of @target
*
* Since: 2.22
*/
* 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
*/
*
* Gets @target's port
*
- * Return value: @target's port
+ * Returns: @target's port
*
* Since: 2.22
*/
* #GResolver already sorts the targets according to the algorithm in
* RFC 2782.
*
- * Return value: @target's priority
+ * Returns: @target's priority
*
* Since: 2.22
*/
* #GResolver already sorts the targets according to the algorithm in
* RFC 2782.
*
- * Return value: @target's weight
+ * Returns: @target's weight
*
* Since: 2.22
*/
*
* 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
*/
*
* 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
*/
* 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
*/
* 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
*
* Wraps @base_io_stream and @socket together as a #GSocketConnection.
*
- * Return value: the new #GSocketConnection.
+ * Returns: the new #GSocketConnection.
*
* Since: 2.28
*/
*
* 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)
* 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
*/
*
* 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
*
* 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
*
* 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
*
* 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
*
* 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
*/
* 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
*/
* 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
*/
* 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
*/
* 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.
*
*
* 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.
*
* (All other #GTlsCertificateFlags values will always be set or unset
* as appropriate.)
*
- * Return value: the appropriate #GTlsCertificateFlags
+ * Returns: the appropriate #GTlsCertificateFlags
*
* Since: 2.28
*/
* 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
*/
* 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
*
* Gets @conn's validation flags
*
- * Return value: the validation flags
+ * Returns: the validation flags
*
* Since: 2.28
*/
*
* 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.
*
* 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
*/
* 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().
*
* 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.
* 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
*/
* 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
*/
* 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
*/
* (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
*/
* 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
*/
* 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
* 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
*/
* #GTlsConnection::accept_certificate may be emitted during the
* handshake.
*
- * Return value: success or failure
+ * Returns: success or failure
*
* Since: 2.28
*/
* 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
*
* Gets the TLS error quark.
*
- * Return value: a #GQuark.
+ * Returns: a #GQuark.
*
* Since: 2.28
*/
* 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
* 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
*
* 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
* 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
* 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
* 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
* 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
* 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
* 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
*
* 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
*
* Get flags about the password.
*
- * Return value: The flags about the password.
+ * Returns: The flags about the password.
*
* Since: 2.30
*/
*
* 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
*/
* representation of the password flags returned from
* g_tls_password_get_flags().
*
- * Return value: The warning.
+ * Returns: The warning.
*
* Since: 2.30
*/
* 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
* 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
*/
*
* 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
*/
* 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
*/
*
* 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
*/
* 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
*/
*
* 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
*/
* 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
*/
*
* 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
*/
* 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)
* 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)
* 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
*
* 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)
* 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
*/
* 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)
*
* 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)
* 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
*
* 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
*
* 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
*
* 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
* 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().
*
* 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().
* 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)
*
* 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)
* `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
*/
* 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
*/
* 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().
*
* 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
**/
* 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().
* 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
* 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
*/
* 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
*/
* 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
*/
* @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
*/
*
* 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
* 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
*/
*
* 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
*/
*
* 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
*/
* 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
* 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
* 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
* 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
* 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
*/
* 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
*/
* 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
*/
* 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
*/
* 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
*/
* 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
*/
* 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
* 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
*/
* 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
*/
* #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
* 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
*/
* 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
*
* Gets the number of bookmarks inside @bookmark.
*
- * Return value: the number of bookmarks
+ * Returns: the number of bookmarks
*
* Since: 2.12
*/
* 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
*/
* 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
* 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)
*
* 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 *
* `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
*
* 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
* 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
* 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
*
* 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.
*
*
* 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
*
* 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
*
* 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
* 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
* 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,
* 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)
* 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.
**/
* 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.
**/
* 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.
**/
* 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 *
* 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 *
* `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
*/
* 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,
* 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*
* 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 *
* 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 *
* 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
* 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
* 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
**/
*
* 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
*/
*
* 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
* 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
* 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
* 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
* 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
* 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
* 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
* 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
* 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
* 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
* #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
*
* 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
*/
* 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
*/
*
* 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
*/
* 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
*/
* 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
*/
* 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
*/
* 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
*/
*
* 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
*/
*
* 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
*/
*
* 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
*/
*
* 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
*/
* 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.
**/
* 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.
**/
* 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.
* 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
* 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
* 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().
* 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,
* @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,
*
* Makes a copy of @error.
*
- * Return value: a new #GError
+ * Returns: a new #GError
*/
GError*
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,
* 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,
* 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)
* 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,
* 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
*/
* 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.
*
* 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.
*
* 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.
* 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
* 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.
* 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.
* 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
*/
* 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,
* 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
*/
* 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,
* 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
* 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 *
*
* 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.
*
* 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,
* 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,
* 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
*/
*
* Returns the #GHashTable associated with @iter.
*
- * Return value: the #GHashTable associated with @iter.
+ * Returns: the #GHashTable associated with @iter.
*
* Since: 2.16
*/
* 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
*/
* 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,
* 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,
* @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.
* 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,
* 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,
* (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.
*
*
* 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)
* 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.
* 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.
* 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
* 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
*
* 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
**/
*
* 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.
*
*
* 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
*
* 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.
*
* 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
* 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
**/
* 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
* 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
* 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
**/
*
* 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.
**/
*
* 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.
**/
* 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.
**/
* 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.
**/
/**
* 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,
* 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)
*
* 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
*
* 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)
* 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 *
*
* 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:
* 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)
* 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
*
* Replacement for g_io_channel_seek() with the new API.
*
- * Return value: the status of the operation.
+ * Returns: the status of the operation.
**/
/**
* GSeekType:
*
* 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.
**/
* 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 *
* @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,
*
* 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,
*
* 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
*
* 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,
* 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,
* 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,
* 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,
/**
* 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:
* 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
**/
* 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
**/
* 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
**/
* 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
**/
* @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
* 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
* 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
*
* 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
**/
* 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
**/
* 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
* 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
* 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().
*
* 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
* 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().
*
* 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
* 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.
* 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
* 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.
* 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
* 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.
*
* 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
**/
* 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
**/
*
* Creates a new #GMainContext structure.
*
- * Return value: the new #GMainContext
+ * Returns: the new #GMainContext
**/
GMainContext *
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)
* 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,
* 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
* 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)
* 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.
**/
*
* 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)
* 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)
* 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 *
*
* Increases the reference count on a source by one.
*
- * Return value: @source
+ * Returns: @source
**/
GSource *
g_source_ref (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,
* 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,
* 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,
*
* 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)
* 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)
* 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,
* 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)
*
* 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
*/
* }
* ]|
*
- * Return value: %TRUE if the source has been destroyed
+ * Returns: %TRUE if the source has been destroyed
*
* Since: 2.12
*/
* 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
* 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
* 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
*
* 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.
**/
*
* 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,
*
* 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)
* 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)
*
* Creates a new #GMainLoop structure.
*
- * Return value: a new #GMainLoop.
+ * Returns: a new #GMainLoop.
**/
GMainLoop *
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)
*
* 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)
*
* 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)
*
* 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)
* 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)
* 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
**/
* 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
* 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,
* 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
* 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
**/
* 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
**/
* 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
* 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
**/
* %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)
* 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
* 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,
*
* 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)
* 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
* 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
* 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
**/
* 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,
* 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,
* 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,
* 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,
* 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 *
* 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
* store, item);
* ]|
*
- * Return value: newly allocated result from formatting
+ * Returns: newly allocated result from formatting
* operation. Free with g_free().
*
* Since: 2.4
* %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
**/
*
* 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)
*
* 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
**/
*
* 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.
*
* 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
*
* 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
* 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.
*
*
* 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
*/
* 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
*/
*
* 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
*/
* 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
*/
*
* 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
*/
*
* 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
*/
*
* 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
*/
*
* 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
*/
*
* 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
*
* 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
*
* 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
*
* 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
*
* 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
*/
*
* 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
*/
*
* 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)
*
* Creates a new random number generator initialized with @seed.
*
- * Return value: the new #GRand
+ * Returns: the new #GRand
*
* Since: 2.4
*/
*
* On Windows, the seed is taken from rand_s().
*
- * Return value: the new #GRand
+ * Returns: the new #GRand
*/
GRand*
g_rand_new (void)
* 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
*/
* 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)
* 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,
* 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)
* 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,
* 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)
* 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,
*
* 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)
* 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,
* 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
**/
* 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
*
* 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
*
* 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
*/
*
* 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
*/
*
* 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
*/
* 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
*/
* 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
* 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
*
* 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
*/
* 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
*
* 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
*
*
* 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
*/
*
* 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
*/
*
* Returns the length of @seq
*
- * Return value: the length of @seq
+ * Returns: the length of @seq
*
* Since: 2.14
*/
*
* Returns the end iterator for @seg
*
- * Return value: the end iterator for @seq
+ * Returns: the end iterator for @seq
*
* Since: 2.14
*/
*
* Returns the begin iterator for @seq.
*
- * Return value: the begin iterator for @seq.
+ * Returns: the begin iterator for @seq.
*
* Since: 2.14
*/
* 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
*/
*
* 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
*/
*
* 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
*/
*
* Returns the position of @iter
*
- * Return value: the position of @iter
+ * Returns: the position of @iter
*
* Since: 2.14
*/
* 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
*/
* 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
* 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
*/
* 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)
* 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,
* 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,
* 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,
* 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,
* 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,
* 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,
*
* 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,
* 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,
* 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,
* 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,
* 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,
* 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,
* 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
*/
* 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
*/
*
* 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.)
*
* 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.)
*
* 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()
*
* 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()
* 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
* 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
* 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
* 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
*
* 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
* 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
* 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
* 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
* 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**
* 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
* 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)
* 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 *
* 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 *
* 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 *
*
* 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
*/
*
* 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
*/
* 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
*/
* 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,
* 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,
* 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,
* 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,
*
* Overwrites part of a string, lengthening it if necessary.
*
- * Return value: @string
+ * Returns: @string
*
* Since: 2.14
*/
* Overwrites part of a string, lengthening it if necessary.
* This function will work with embedded nuls.
*
- * Return value: @string
+ * Returns: @string
*
* Since: 2.14
*/
*
* 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().
*/
*
* 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().
*/
*
* 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.
* 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
*/
*
* 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
*/
* 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,
*
* 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,
*
* 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,
*
* 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)
*
* 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)
*
* 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)
*
* 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)
*
* 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)
* 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
*
* 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
*/
* 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
*/
*
* Creates a new #GTree.
*
- * Return value: a newly allocated #GTree
+ * Returns: a newly allocated #GTree
*/
GTree *
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,
* 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,
*
* It is safe to call this function from any thread.
*
- * Return value: the passed in #GTree
+ * Returns: the passed in #GTree
*
* Since: 2.22
*/
* 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
* 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,
* @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
* 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)
*
* 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)
* 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)
* 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
*
* 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 *
*
* 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
*
* 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
**/
*
* 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()
* 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.
**/
* [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
**/
* 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)
* 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)
* 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)
* 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)
* 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)
* 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)
* 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)
* 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)
* 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)
* 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
**/
*
* 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)
* 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)
*
* 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)
* 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)
* 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
**/
* 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)
* 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
*/
*
* 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.
**/
*
* 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.
**/
*
* 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.
**/
* 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
* 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
*
* 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)
* 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 *
* 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 *
* 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 *
* 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
**/
* 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
*/
* [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.
*
* [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.
*
* 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,
* 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,
* 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)
* 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,
* 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)
* 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,
* 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,
* 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,
*
* 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,
* 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.
*/
* 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.
*/
* 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
* 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 *
* 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.
*/
* 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.
* 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.
**/
* 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.
*/
* 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.
*/
* 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.
*/
* 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,
* 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)
* 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 *
* 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
**/
* 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
**/
* 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
**/
* 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
**/
* 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.
*
* 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
**/
* 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
**/
* 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.
* 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
*
* 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
*/
*
* 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
*/
*
* 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
*/
* 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
*/
* 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
*/
* 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.
*
*
* 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.
*
*
* 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.
*
* @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
projects / platform / upstream / glib.git / commitdiff