Merge branch 'docs-fixes' into 'master'

Various minor documentation fixes

See merge request GNOME/glib!716
This commit is contained in:
Sebastian Dröge 2019-03-15 11:46:22 +00:00
commit c3cfbd26da
34 changed files with 142 additions and 77 deletions

View File

@ -118,6 +118,13 @@ if get_option('gtk_doc')
] ]
endif endif
ignore_sources = [
'kqueue',
'tests',
'gdbus-daemon-generated.c',
'xdp-dbus.c',
]
# FIXME: More win32 headers were added to fix building gio-scan # FIXME: More win32 headers were added to fix building gio-scan
# FIXME: ExampleAnimal docs aren't built # FIXME: ExampleAnimal docs aren't built
@ -141,6 +148,9 @@ if get_option('gtk_doc')
'--rebuild-types', '--rebuild-types',
'--ignore-headers=' + ' '.join(ignore_headers), '--ignore-headers=' + ' '.join(ignore_headers),
], ],
mkdb_args : [
'--ignore-files=' + ' '.join(ignore_sources),
],
content_files : [ content_files : [
'overview.xml', 'overview.xml',
'migrating-posix.xml', 'migrating-posix.xml',

View File

@ -4710,7 +4710,7 @@ g_desktop_app_info_get_boolean (GDesktopAppInfo *info,
* a %NULL-terminated string array or %NULL if the specified * a %NULL-terminated string array or %NULL if the specified
* key cannot be found. The array should be freed with g_strfreev(). * key cannot be found. The array should be freed with g_strfreev().
* *
* Since: 2.60.0 * Since: 2.60
*/ */
gchar ** gchar **
g_desktop_app_info_get_string_list (GDesktopAppInfo *info, g_desktop_app_info_get_string_list (GDesktopAppInfo *info,

View File

@ -129,11 +129,13 @@ void g_dtls_connection_set_require_close_notify (GDtlsConnec
GLIB_AVAILABLE_IN_2_48 GLIB_AVAILABLE_IN_2_48
gboolean g_dtls_connection_get_require_close_notify (GDtlsConnection *conn); gboolean g_dtls_connection_get_require_close_notify (GDtlsConnection *conn);
#ifndef G_DISABLE_DEPRECATED
GLIB_DEPRECATED_IN_2_60 GLIB_DEPRECATED_IN_2_60
void g_dtls_connection_set_rehandshake_mode (GDtlsConnection *conn, void g_dtls_connection_set_rehandshake_mode (GDtlsConnection *conn,
GTlsRehandshakeMode mode); GTlsRehandshakeMode mode);
GLIB_DEPRECATED_IN_2_60 GLIB_DEPRECATED_IN_2_60
GTlsRehandshakeMode g_dtls_connection_get_rehandshake_mode (GDtlsConnection *conn); GTlsRehandshakeMode g_dtls_connection_get_rehandshake_mode (GDtlsConnection *conn);
#endif /* !G_DISABLE_DEPRECATED */
GLIB_AVAILABLE_IN_2_48 GLIB_AVAILABLE_IN_2_48
gboolean g_dtls_connection_handshake (GDtlsConnection *conn, gboolean g_dtls_connection_handshake (GDtlsConnection *conn,

View File

@ -6934,6 +6934,7 @@ query_default_handler_query_info_cb (GObject *object,
/** /**
* g_file_query_default_handler_async: * g_file_query_default_handler_async:
* @file: a #GFile to open * @file: a #GFile to open
* @io_priority: the [I/O priority][io-priority] of the request
* @cancellable: optional #GCancellable object, %NULL to ignore * @cancellable: optional #GCancellable object, %NULL to ignore
* @callback: (nullable): a #GAsyncReadyCallback to call when the request is done * @callback: (nullable): a #GAsyncReadyCallback to call when the request is done
* @user_data: (nullable): data to pass to @callback * @user_data: (nullable): data to pass to @callback
@ -7963,7 +7964,7 @@ g_file_real_measure_disk_usage_finish (GFile *file,
* *
* By default, errors are only reported against the toplevel file * By default, errors are only reported against the toplevel file
* itself. Errors found while recursing are silently ignored, unless * itself. Errors found while recursing are silently ignored, unless
* %G_FILE_DISK_USAGE_REPORT_ALL_ERRORS is given in @flags. * %G_FILE_MEASURE_REPORT_ANY_ERROR is given in @flags.
* *
* The returned size, @disk_usage, is in bytes and should be formatted * The returned size, @disk_usage, is in bytes and should be formatted
* with g_format_size() in order to get something reasonable for showing * with g_format_size() in order to get something reasonable for showing

View File

@ -80,14 +80,14 @@ typedef struct _GFileIface GFileIface;
* @set_display_name: Sets the display name for a #GFile. * @set_display_name: Sets the display name for a #GFile.
* @set_display_name_async: Asynchronously sets a #GFile's display name. * @set_display_name_async: Asynchronously sets a #GFile's display name.
* @set_display_name_finish: Finishes asynchronously setting a #GFile's display name. * @set_display_name_finish: Finishes asynchronously setting a #GFile's display name.
* @query_settable_attributes: Returns a list of #GFileAttributes that can be set. * @query_settable_attributes: Returns a list of #GFileAttributeInfos that can be set.
* @_query_settable_attributes_async: Asynchronously gets a list of #GFileAttributes that can be set. * @_query_settable_attributes_async: Asynchronously gets a list of #GFileAttributeInfos that can be set.
* @_query_settable_attributes_finish: Finishes asynchronously querying settable attributes. * @_query_settable_attributes_finish: Finishes asynchronously querying settable attributes.
* @query_writable_namespaces: Returns a list of #GFileAttribute namespaces that are writable. * @query_writable_namespaces: Returns a list of #GFileAttributeInfo namespaces that are writable.
* @_query_writable_namespaces_async: Asynchronously gets a list of #GFileAttribute namespaces that are writable. * @_query_writable_namespaces_async: Asynchronously gets a list of #GFileAttributeInfo namespaces that are writable.
* @_query_writable_namespaces_finish: Finishes asynchronously querying the writable namespaces. * @_query_writable_namespaces_finish: Finishes asynchronously querying the writable namespaces.
* @set_attribute: Sets a #GFileAttribute. * @set_attribute: Sets a #GFileAttributeInfo.
* @set_attributes_from_info: Sets a #GFileAttribute with information from a #GFileInfo. * @set_attributes_from_info: Sets a #GFileAttributeInfo with information from a #GFileInfo.
* @set_attributes_async: Asynchronously sets a file's attributes. * @set_attributes_async: Asynchronously sets a file's attributes.
* @set_attributes_finish: Finishes setting a file's attributes asynchronously. * @set_attributes_finish: Finishes setting a file's attributes asynchronously.
* @read_fn: Reads a file asynchronously. * @read_fn: Reads a file asynchronously.

View File

@ -1045,7 +1045,7 @@ g_input_stream_skip_async (GInputStream *stream,
* *
* Finishes a stream skip operation. * Finishes a stream skip operation.
* *
* Returns: the size of the bytes skipped, or %-1 on error. * Returns: the size of the bytes skipped, or `-1` on error.
**/ **/
gssize gssize
g_input_stream_skip_finish (GInputStream *stream, g_input_stream_skip_finish (GInputStream *stream,

View File

@ -1603,6 +1603,7 @@ typedef enum {
G_TLS_AUTHENTICATION_REQUIRED G_TLS_AUTHENTICATION_REQUIRED
} GTlsAuthenticationMode; } GTlsAuthenticationMode;
#ifndef G_DISABLE_DEPRECATED
/** /**
* GTlsRehandshakeMode: * GTlsRehandshakeMode:
* @G_TLS_REHANDSHAKE_NEVER: Never allow rehandshaking * @G_TLS_REHANDSHAKE_NEVER: Never allow rehandshaking
@ -1623,6 +1624,7 @@ typedef enum {
G_TLS_REHANDSHAKE_SAFELY, G_TLS_REHANDSHAKE_SAFELY,
G_TLS_REHANDSHAKE_UNSAFELY G_TLS_REHANDSHAKE_UNSAFELY
} GTlsRehandshakeMode; } GTlsRehandshakeMode;
#endif /* !G_DISABLE_DEPRECATED */
/** /**
* GTlsPasswordFlags: * GTlsPasswordFlags:

View File

@ -335,7 +335,7 @@ typedef gboolean (* GFileReadMoreCallback) (const char *file_contents,
* final async result would be reported). * final async result would be reported).
* *
* @current_size is in the same units as requested by the operation (see * @current_size is in the same units as requested by the operation (see
* %G_FILE_DISK_USAGE_APPARENT_SIZE). * %G_FILE_MEASURE_APPARENT_SIZE).
* *
* The frequency of the updates is implementation defined, but is * The frequency of the updates is implementation defined, but is
* ideally about once every 200ms. * ideally about once every 200ms.

View File

@ -799,7 +799,7 @@ g_mount_operation_set_password_save (GMountOperation *op,
* Gets a choice from the mount operation. * Gets a choice from the mount operation.
* *
* Returns: an integer containing an index of the user's choice from * Returns: an integer containing an index of the user's choice from
* the choice's list, or %0. * the choice's list, or `0`.
**/ **/
int int
g_mount_operation_get_choice (GMountOperation *op) g_mount_operation_get_choice (GMountOperation *op)

View File

@ -306,7 +306,7 @@ g_network_address_new (const gchar *hostname,
* resolving `localhost`, and an IPv6 address for `localhost6`. * resolving `localhost`, and an IPv6 address for `localhost6`.
* *
* g_network_address_get_hostname() will always return `localhost` for * g_network_address_get_hostname() will always return `localhost` for
* #GNetworkAddresses created with this constructor. * a #GNetworkAddress created with this constructor.
* *
* Returns: (transfer full) (type GNetworkAddress): the new #GNetworkAddress * Returns: (transfer full) (type GNetworkAddress): the new #GNetworkAddress
* *

View File

@ -49,6 +49,8 @@ typedef struct _GPollableOutputStreamInterface GPollableOutputStreamInterface;
* @create_source: Creates a #GSource to poll the stream * @create_source: Creates a #GSource to poll the stream
* @write_nonblocking: Does a non-blocking write or returns * @write_nonblocking: Does a non-blocking write or returns
* %G_IO_ERROR_WOULD_BLOCK * %G_IO_ERROR_WOULD_BLOCK
* @writev_nonblocking: Does a vectored non-blocking write, or returns
* %G_POLLABLE_RETURN_WOULD_BLOCK
* *
* The interface for pollable output streams. * The interface for pollable output streams.
* *
@ -61,6 +63,12 @@ typedef struct _GPollableOutputStreamInterface GPollableOutputStreamInterface;
* implementation may return %TRUE when the stream is not actually * implementation may return %TRUE when the stream is not actually
* writable. * writable.
* *
* The default implementation of @writev_nonblocking calls
* g_pollable_output_stream_write_nonblocking() for each vector, and converts
* its return value and error (if set) to a #GPollableReturn. You should
* override this where possible to avoid having to allocate a #GError to return
* %G_IO_ERROR_WOULD_BLOCK.
*
* Since: 2.28 * Since: 2.28
*/ */
struct _GPollableOutputStreamInterface struct _GPollableOutputStreamInterface

View File

@ -40,7 +40,7 @@ G_BEGIN_DECLS
* GProxyAddressEnumerator: * GProxyAddressEnumerator:
* *
* A subclass of #GSocketAddressEnumerator that takes another address * A subclass of #GSocketAddressEnumerator that takes another address
* enumerator and wraps its results in #GProxyAddresses as * enumerator and wraps each of its results in a #GProxyAddress as
* directed by the default #GProxyResolver. * directed by the default #GProxyResolver.
*/ */

View File

@ -92,9 +92,12 @@ gboolean g_simple_async_result_get_op_res_gboolean (GSimpleAsyncResul
#ifndef G_DISABLE_DEPRECATED
GLIB_AVAILABLE_IN_2_32 /* Also deprecated, but can't mark something both AVAILABLE and DEPRECATED */ GLIB_AVAILABLE_IN_2_32 /* Also deprecated, but can't mark something both AVAILABLE and DEPRECATED */
void g_simple_async_result_set_check_cancellable (GSimpleAsyncResult *simple, void g_simple_async_result_set_check_cancellable (GSimpleAsyncResult *simple,
GCancellable *check_cancellable); GCancellable *check_cancellable);
#endif /* !G_DISABLE_DEPRECATED */
GLIB_DEPRECATED_IN_2_46 GLIB_DEPRECATED_IN_2_46
gpointer g_simple_async_result_get_source_tag (GSimpleAsyncResult *simple); gpointer g_simple_async_result_get_source_tag (GSimpleAsyncResult *simple);
GLIB_DEPRECATED_IN_2_46 GLIB_DEPRECATED_IN_2_46

View File

@ -30,7 +30,7 @@
* #GSocketAddressEnumerator is an enumerator type for #GSocketAddress * #GSocketAddressEnumerator is an enumerator type for #GSocketAddress
* instances. It is returned by enumeration functions such as * instances. It is returned by enumeration functions such as
* g_socket_connectable_enumerate(), which returns a #GSocketAddressEnumerator * g_socket_connectable_enumerate(), which returns a #GSocketAddressEnumerator
* to list all the #GSocketAddresses which could be used to connect to that * to list each #GSocketAddress which could be used to connect to that
* #GSocketConnectable. * #GSocketConnectable.
* *
* Enumeration is typically a blocking operation, so the asynchronous methods * Enumeration is typically a blocking operation, so the asynchronous methods

View File

@ -457,7 +457,7 @@ g_socket_client_get_protocol (GSocketClient *client)
* The sockets created by this object will use of the specified * The sockets created by this object will use of the specified
* protocol. * protocol.
* *
* If @protocol is %0 that means to use the default * If @protocol is %G_SOCKET_PROTOCOL_DEFAULT that means to use the default
* protocol for the socket family and type. * protocol for the socket family and type.
* *
* Since: 2.22 * Since: 2.22

View File

@ -121,7 +121,7 @@ g_socket_connectable_enumerate (GSocketConnectable *connectable)
* @connectable: a #GSocketConnectable * @connectable: a #GSocketConnectable
* *
* Creates a #GSocketAddressEnumerator for @connectable that will * Creates a #GSocketAddressEnumerator for @connectable that will
* return #GProxyAddresses for addresses that you must connect * return a #GProxyAddress for each of its addresses that you must connect
* to via a proxy. * to via a proxy.
* *
* If @connectable does not implement * If @connectable does not implement

View File

@ -35,7 +35,7 @@ G_BEGIN_DECLS
/** /**
* GSocketConnectable: * GSocketConnectable:
* *
* Interface for objects that contain or generate #GSocketAddresses. * Interface for objects that contain or generate a #GSocketAddress.
*/ */
typedef struct _GSocketConnectableIface GSocketConnectableIface; typedef struct _GSocketConnectableIface GSocketConnectableIface;

View File

@ -109,11 +109,13 @@ void g_tls_connection_set_require_close_notify (GTlsConnecti
GLIB_AVAILABLE_IN_ALL GLIB_AVAILABLE_IN_ALL
gboolean g_tls_connection_get_require_close_notify (GTlsConnection *conn); gboolean g_tls_connection_get_require_close_notify (GTlsConnection *conn);
#ifndef G_DISABLE_DEPRECATED
GLIB_DEPRECATED_IN_2_60 GLIB_DEPRECATED_IN_2_60
void g_tls_connection_set_rehandshake_mode (GTlsConnection *conn, void g_tls_connection_set_rehandshake_mode (GTlsConnection *conn,
GTlsRehandshakeMode mode); GTlsRehandshakeMode mode);
GLIB_DEPRECATED_IN_2_60 GLIB_DEPRECATED_IN_2_60
GTlsRehandshakeMode g_tls_connection_get_rehandshake_mode (GTlsConnection *conn); GTlsRehandshakeMode g_tls_connection_get_rehandshake_mode (GTlsConnection *conn);
#endif /* !G_DISABLE_DEPRECATED */
GLIB_AVAILABLE_IN_2_60 GLIB_AVAILABLE_IN_2_60
void g_tls_connection_set_advertised_protocols (GTlsConnection *conn, void g_tls_connection_set_advertised_protocols (GTlsConnection *conn,

View File

@ -744,7 +744,7 @@ g_tls_database_lookup_certificate_for_handle_async (GTlsDatabase *sel
* @error: a #GError pointer, or %NULL * @error: a #GError pointer, or %NULL
* *
* Finish an asynchronous lookup of a certificate by its handle. See * Finish an asynchronous lookup of a certificate by its handle. See
* g_tls_database_lookup_certificate_by_handle() for more information. * g_tls_database_lookup_certificate_for_handle() for more information.
* *
* If the handle is no longer valid, or does not point to a certificate in * If the handle is no longer valid, or does not point to a certificate in
* this database, then %NULL will be returned. * this database, then %NULL will be returned.

View File

@ -23,7 +23,7 @@
* descriptors that it contains, closing them when finalized. * descriptors that it contains, closing them when finalized.
* *
* It may be wrapped in a #GUnixFDMessage and sent over a #GSocket in * It may be wrapped in a #GUnixFDMessage and sent over a #GSocket in
* the %G_SOCKET_ADDRESS_UNIX family by using g_socket_send_message() * the %G_SOCKET_FAMILY_UNIX family by using g_socket_send_message()
* and received using g_socket_receive_message(). * and received using g_socket_receive_message().
* *
* Note that `<gio/gunixfdlist.h>` belongs to the UNIX-specific GIO * Note that `<gio/gunixfdlist.h>` belongs to the UNIX-specific GIO

View File

@ -22,7 +22,7 @@
* This #GSocketControlMessage contains a #GUnixFDList. * This #GSocketControlMessage contains a #GUnixFDList.
* It may be sent using g_socket_send_message() and received using * It may be sent using g_socket_send_message() and received using
* g_socket_receive_message() over UNIX sockets (ie: sockets in the * g_socket_receive_message() over UNIX sockets (ie: sockets in the
* %G_SOCKET_ADDRESS_UNIX family). The file descriptors are copied * %G_SOCKET_FAMILY_UNIX family). The file descriptors are copied
* between processes by the kernel. * between processes by the kernel.
* *
* For an easier way to send and receive file descriptors over * For an easier way to send and receive file descriptors over

View File

@ -97,6 +97,9 @@
* Deprecated:2.32:POSIX threads are in use on all non-Windows systems. * Deprecated:2.32:POSIX threads are in use on all non-Windows systems.
* Use G_OS_WIN32 to detect Windows. * Use G_OS_WIN32 to detect Windows.
*/ */
#ifdef G_DISABLE_DEPRECATED
#undef G_THREADS_IMPL_POSIX
#endif
/** /**
* G_THREADS_IMPL_WIN32: * G_THREADS_IMPL_WIN32:
@ -105,7 +108,9 @@
* *
* Deprecated:2.32:Use G_OS_WIN32 to detect Windows. * Deprecated:2.32:Use G_OS_WIN32 to detect Windows.
*/ */
#ifdef G_DISABLE_DEPRECATED
#undef G_THREADS_IMPL_WIN32
#endif
/* {{{1 Exported Variables */ /* {{{1 Exported Variables */

View File

@ -1845,23 +1845,6 @@
* arrays or arrays on the stack. * arrays or arrays on the stack.
*/ */
/**
* G_ALIGNOF
* @a: a type-name
*
* Return the minimal alignment required by the platform ABI for values of the given
* type. The address of a variable or struct member of the given type must always be
* a multiple of this alignment. For example, most platforms require int variables
* to be aligned at a 4-byte boundary, so `G_ALIGNOF (int)` is 4 on most platforms.
*
* Note this is not necessarily the same as the value returned by GCCs
* `__alignof__` operator, which returns the preferred alignment for a type.
* The preferred alignment may be a stricter alignment than the minimal
* alignment.
*
* Since: 2.60
*/
/* Miscellaneous Macros {{{1 */ /* Miscellaneous Macros {{{1 */
/** /**
@ -1873,20 +1856,6 @@
* needed so often by application programmers. * needed so often by application programmers.
*/ */
/**
* G_INLINE_FUNC:
*
* This macro used to be used to conditionally define inline functions
* in a compatible way before this feature was supported in all
* compilers. These days, GLib requires inlining support from the
* compiler, so your GLib-using programs can safely assume that the
* "inline" keywork works properly.
*
* Never use this macro anymore. Just say "static inline".
*
* Deprecated: 2.48: Use "static inline" instead
*/
/** /**
* G_STMT_START: * G_STMT_START:
* *

View File

@ -2779,7 +2779,7 @@ format_z (GString *outstr,
} }
#ifdef HAVE_LANGINFO_OUTDIGIT #ifdef HAVE_LANGINFO_OUTDIGIT
/** Initializes the array with UTF-8 encoded alternate digits suitable for use /* Initializes the array with UTF-8 encoded alternate digits suitable for use
* in current locale. Returns NULL when current locale does not use alternate * in current locale. Returns NULL when current locale does not use alternate
* digits or there was an error converting them to UTF-8. * digits or there was an error converting them to UTF-8.
*/ */

View File

@ -82,6 +82,21 @@
#undef G_INLINE_DEFINE_NEEDED #undef G_INLINE_DEFINE_NEEDED
/**
* G_INLINE_FUNC:
*
* This macro used to be used to conditionally define inline functions
* in a compatible way before this feature was supported in all
* compilers. These days, GLib requires inlining support from the
* compiler, so your GLib-using programs can safely assume that the
* "inline" keywork works properly.
*
* Never use this macro anymore. Just say "static inline".
*
* Deprecated: 2.48: Use "static inline" instead
*/
#ifndef G_DISABLE_DEPRECATED
/* For historical reasons we need to continue to support those who /* For historical reasons we need to continue to support those who
* define G_IMPLEMENT_INLINES to mean "don't implement this here". * define G_IMPLEMENT_INLINES to mean "don't implement this here".
*/ */
@ -91,6 +106,7 @@
#else #else
# define G_INLINE_FUNC static inline # define G_INLINE_FUNC static inline
#endif /* G_IMPLEMENT_INLINES */ #endif /* G_IMPLEMENT_INLINES */
#endif /* !G_DISABLE_DEPRECATED */
/* Provide macros to feature the GCC function attribute. /* Provide macros to feature the GCC function attribute.
*/ */
@ -829,6 +845,22 @@
* https://gitlab.gnome.org/GNOME/glib/merge_requests/538/diffs#note_390790. * https://gitlab.gnome.org/GNOME/glib/merge_requests/538/diffs#note_390790.
*/ */
/**
* G_ALIGNOF
* @type: a type-name
*
* Return the minimal alignment required by the platform ABI for values of the given
* type. The address of a variable or struct member of the given type must always be
* a multiple of this alignment. For example, most platforms require int variables
* to be aligned at a 4-byte boundary, so `G_ALIGNOF (int)` is 4 on most platforms.
*
* Note this is not necessarily the same as the value returned by GCCs
* `__alignof__` operator, which returns the preferred alignment for a type.
* The preferred alignment may be a stricter alignment than the minimal
* alignment.
*
* Since: 2.60
*/
#if defined(__STDC_VERSION__) && __STDC_VERSION__ >= 201112L && !defined(__cplusplus) #if defined(__STDC_VERSION__) && __STDC_VERSION__ >= 201112L && !defined(__cplusplus)
#define G_ALIGNOF(type) _Alignof (type) #define G_ALIGNOF(type) _Alignof (type)
#else #else

View File

@ -381,7 +381,10 @@ GLIB_VAR gboolean g_mem_gc_friendly;
/* Memory profiler and checker, has to be enabled via g_mem_set_vtable() /* Memory profiler and checker, has to be enabled via g_mem_set_vtable()
*/ */
#ifndef G_DISABLE_DEPRECATED
GLIB_VAR GMemVTable *glib_mem_profiler_table; GLIB_VAR GMemVTable *glib_mem_profiler_table;
#endif
GLIB_DEPRECATED_IN_2_46 GLIB_DEPRECATED_IN_2_46
void g_mem_profile (void); void g_mem_profile (void);

View File

@ -347,28 +347,6 @@
* Since: 2.16 * Since: 2.16
*/ */
/**
* GTestTrapFlags:
* @G_TEST_TRAP_SILENCE_STDOUT: Redirect stdout of the test child to
* `/dev/null` so it cannot be observed on the console during test
* runs. The actual output is still captured though to allow later
* tests with g_test_trap_assert_stdout().
* @G_TEST_TRAP_SILENCE_STDERR: Redirect stderr of the test child to
* `/dev/null` so it cannot be observed on the console during test
* runs. The actual output is still captured though to allow later
* tests with g_test_trap_assert_stderr().
* @G_TEST_TRAP_INHERIT_STDIN: If this flag is given, stdin of the
* child process is shared with stdin of its parent process.
* It is redirected to `/dev/null` otherwise.
*
* Test traps are guards around forked tests.
* These flags determine what traps to set.
*
* Deprecated: #GTestTrapFlags is used only with g_test_trap_fork(),
* which is deprecated. g_test_trap_subprocess() uses
* #GTestSubprocessFlags.
*/
/** /**
* GTestSubprocessFlags: * GTestSubprocessFlags:
* @G_TEST_SUBPROCESS_INHERIT_STDIN: If this flag is given, the child * @G_TEST_SUBPROCESS_INHERIT_STDIN: If this flag is given, the child

View File

@ -337,6 +337,28 @@ void g_test_queue_destroy (GDestroyNotify destroy_func,
gpointer destroy_data); gpointer destroy_data);
#define g_test_queue_unref(gobject) g_test_queue_destroy (g_object_unref, gobject) #define g_test_queue_unref(gobject) g_test_queue_destroy (g_object_unref, gobject)
#ifndef G_DISABLE_DEPRECATED
/**
* GTestTrapFlags:
* @G_TEST_TRAP_SILENCE_STDOUT: Redirect stdout of the test child to
* `/dev/null` so it cannot be observed on the console during test
* runs. The actual output is still captured though to allow later
* tests with g_test_trap_assert_stdout().
* @G_TEST_TRAP_SILENCE_STDERR: Redirect stderr of the test child to
* `/dev/null` so it cannot be observed on the console during test
* runs. The actual output is still captured though to allow later
* tests with g_test_trap_assert_stderr().
* @G_TEST_TRAP_INHERIT_STDIN: If this flag is given, stdin of the
* child process is shared with stdin of its parent process.
* It is redirected to `/dev/null` otherwise.
*
* Test traps are guards around forked tests.
* These flags determine what traps to set.
*
* Deprecated: #GTestTrapFlags is used only with g_test_trap_fork(),
* which is deprecated. g_test_trap_subprocess() uses
* #GTestSubprocessFlags.
*/
typedef enum { typedef enum {
G_TEST_TRAP_SILENCE_STDOUT = 1 << 7, G_TEST_TRAP_SILENCE_STDOUT = 1 << 7,
G_TEST_TRAP_SILENCE_STDERR = 1 << 8, G_TEST_TRAP_SILENCE_STDERR = 1 << 8,
@ -346,6 +368,7 @@ typedef enum {
GLIB_DEPRECATED_IN_2_38_FOR (g_test_trap_subprocess) GLIB_DEPRECATED_IN_2_38_FOR (g_test_trap_subprocess)
gboolean g_test_trap_fork (guint64 usec_timeout, gboolean g_test_trap_fork (guint64 usec_timeout,
GTestTrapFlags test_trap_flags); GTestTrapFlags test_trap_flags);
#endif /* !G_DISABLE_DEPRECATED */
typedef enum { typedef enum {
G_TEST_SUBPROCESS_INHERIT_STDIN = 1 << 0, G_TEST_SUBPROCESS_INHERIT_STDIN = 1 << 0,

View File

@ -33,6 +33,8 @@
G_BEGIN_DECLS G_BEGIN_DECLS
#ifndef G_DISABLE_DEPRECATED
typedef struct _GTrashStack GTrashStack; typedef struct _GTrashStack GTrashStack;
struct _GTrashStack struct _GTrashStack
{ {
@ -49,6 +51,8 @@ gpointer g_trash_stack_peek (GTrashStack **stack_p);
GLIB_DEPRECATED_IN_2_48 GLIB_DEPRECATED_IN_2_48
guint g_trash_stack_height (GTrashStack **stack_p); guint g_trash_stack_height (GTrashStack **stack_p);
#endif /* !G_DISABLE_DEPRECATED */
G_END_DECLS G_END_DECLS
#endif /* __G_TRASH_STACK_H_ */ #endif /* __G_TRASH_STACK_H_ */

View File

@ -260,6 +260,8 @@ struct _GParamSpecClass
/*< private >*/ /*< private >*/
gpointer dummy[4]; gpointer dummy[4];
}; };
#ifndef G_DISABLE_DEPRECATED
/** /**
* GParameter: * GParameter:
* @name: the parameter name * @name: the parameter name
@ -275,7 +277,7 @@ struct _GParameter /* auxiliary structure for _setv() variants */
const gchar *name; const gchar *name;
GValue value; GValue value;
}; };
#endif /* !G_DISABLE_DEPRECATED */
/* --- prototypes --- */ /* --- prototypes --- */
GLIB_AVAILABLE_IN_ALL GLIB_AVAILABLE_IN_ALL

View File

@ -452,7 +452,10 @@ G_BEGIN_DECLS
* *
* Deprecated: 2.32: Use #GArray instead of #GValueArray * Deprecated: 2.32: Use #GArray instead of #GValueArray
*/ */
#ifndef G_DISABLE_DEPRECATED
#define G_TYPE_PARAM_VALUE_ARRAY (g_param_spec_types[18]) #define G_TYPE_PARAM_VALUE_ARRAY (g_param_spec_types[18])
#endif
/** /**
* G_IS_PARAM_SPEC_VALUE_ARRAY: * G_IS_PARAM_SPEC_VALUE_ARRAY:
* @pspec: a valid #GParamSpec instance * @pspec: a valid #GParamSpec instance
@ -463,7 +466,10 @@ G_BEGIN_DECLS
* *
* Deprecated: 2.32: Use #GArray instead of #GValueArray * Deprecated: 2.32: Use #GArray instead of #GValueArray
*/ */
#ifndef G_DISABLE_DEPRECATED
#define G_IS_PARAM_SPEC_VALUE_ARRAY(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_VALUE_ARRAY)) #define G_IS_PARAM_SPEC_VALUE_ARRAY(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM_VALUE_ARRAY))
#endif
/** /**
* G_PARAM_SPEC_VALUE_ARRAY: * G_PARAM_SPEC_VALUE_ARRAY:
* @pspec: a valid #GParamSpec instance * @pspec: a valid #GParamSpec instance
@ -472,7 +478,9 @@ G_BEGIN_DECLS
* *
* Deprecated: 2.32: Use #GArray instead of #GValueArray * Deprecated: 2.32: Use #GArray instead of #GValueArray
*/ */
#ifndef G_DISABLE_DEPRECATED
#define G_PARAM_SPEC_VALUE_ARRAY(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_VALUE_ARRAY, GParamSpecValueArray)) #define G_PARAM_SPEC_VALUE_ARRAY(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM_VALUE_ARRAY, GParamSpecValueArray))
#endif
/** /**
* G_TYPE_PARAM_OBJECT: * G_TYPE_PARAM_OBJECT:

View File

@ -621,6 +621,7 @@ struct _GTypeQuery
*/ */
#define G_TYPE_FROM_INTERFACE(g_iface) (((GTypeInterface*) (g_iface))->g_type) #define G_TYPE_FROM_INTERFACE(g_iface) (((GTypeInterface*) (g_iface))->g_type)
#ifndef G_DISABLE_DEPRECATED
/** /**
* G_TYPE_INSTANCE_GET_PRIVATE: * G_TYPE_INSTANCE_GET_PRIVATE:
* @instance: the instance of a type deriving from @private_type * @instance: the instance of a type deriving from @private_type
@ -639,6 +640,7 @@ struct _GTypeQuery
* Returns: (not nullable): a pointer to the private data structure * Returns: (not nullable): a pointer to the private data structure
*/ */
#define G_TYPE_INSTANCE_GET_PRIVATE(instance, g_type, c_type) ((c_type*) g_type_instance_get_private ((GTypeInstance*) (instance), (g_type))) #define G_TYPE_INSTANCE_GET_PRIVATE(instance, g_type, c_type) ((c_type*) g_type_instance_get_private ((GTypeInstance*) (instance), (g_type)))
#endif /* !G_DISABLE_DEPRECATED */
/** /**
* G_TYPE_CLASS_GET_PRIVATE: * G_TYPE_CLASS_GET_PRIVATE:
@ -657,6 +659,7 @@ struct _GTypeQuery
*/ */
#define G_TYPE_CLASS_GET_PRIVATE(klass, g_type, c_type) ((c_type*) g_type_class_get_private ((GTypeClass*) (klass), (g_type))) #define G_TYPE_CLASS_GET_PRIVATE(klass, g_type, c_type) ((c_type*) g_type_class_get_private ((GTypeClass*) (klass), (g_type)))
#ifndef G_DISABLE_DEPRECATED
/** /**
* GTypeDebugFlags: * GTypeDebugFlags:
* @G_TYPE_DEBUG_NONE: Print no messages * @G_TYPE_DEBUG_NONE: Print no messages
@ -681,13 +684,17 @@ typedef enum /*< skip >*/
G_TYPE_DEBUG_INSTANCE_COUNT = 1 << 2, G_TYPE_DEBUG_INSTANCE_COUNT = 1 << 2,
G_TYPE_DEBUG_MASK = 0x07 G_TYPE_DEBUG_MASK = 0x07
} GTypeDebugFlags; } GTypeDebugFlags;
#endif /* !G_DISABLE_DEPRECATED */
/* --- prototypes --- */ /* --- prototypes --- */
GLIB_DEPRECATED_IN_2_36 GLIB_DEPRECATED_IN_2_36
void g_type_init (void); void g_type_init (void);
#ifndef G_DISABLE_DEPRECATED
GLIB_DEPRECATED_IN_2_36 GLIB_DEPRECATED_IN_2_36
void g_type_init_with_debug_flags (GTypeDebugFlags debug_flags); void g_type_init_with_debug_flags (GTypeDebugFlags debug_flags);
#endif
GLIB_AVAILABLE_IN_ALL GLIB_AVAILABLE_IN_ALL
const gchar * g_type_name (GType type); const gchar * g_type_name (GType type);
GLIB_AVAILABLE_IN_ALL GLIB_AVAILABLE_IN_ALL

View File

@ -55,6 +55,9 @@
* GArray *array = g_array_sized_new (FALSE, TRUE, sizeof (GValue), 10); * GArray *array = g_array_sized_new (FALSE, TRUE, sizeof (GValue), 10);
* g_array_set_clear_func (array, (GDestroyNotify) g_value_unset); * g_array_set_clear_func (array, (GDestroyNotify) g_value_unset);
* ]| * ]|
*
* Deprecated: 2.32: Use #GArray instead, if possible for the given use case,
* as described above.
*/ */
#define GROUP_N_VALUES (8) /* power of 2 !! */ #define GROUP_N_VALUES (8) /* power of 2 !! */

View File

@ -27,6 +27,8 @@
G_BEGIN_DECLS G_BEGIN_DECLS
#ifndef G_DISABLE_DEPRECATED
/** /**
* G_TYPE_VALUE_ARRAY: * G_TYPE_VALUE_ARRAY:
* *
@ -98,6 +100,7 @@ GValueArray* g_value_array_sort_with_data (GValueArray *value_array,
GCompareDataFunc compare_func, GCompareDataFunc compare_func,
gpointer user_data); gpointer user_data);
#endif /* !G_DISABLE_DEPRECATED */
G_END_DECLS G_END_DECLS