luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-01-23 04:36:17 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: fix up docs issues in gio/

Browse Source
This commit is contained in:
Xavier Claessens 2015-02-05 16:20:43 +01:00 committed by Ryan Lortie
parent 6a97275c45
commit 74c22150cf
49 changed files with 385 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/reference/gio/Makefile.am
View File

@ -25,18 +25,24 @@ IGNORE_HFILES = \
gdbus-2.0 \
gvdb \
inotify \
kqueue \
libasyncns \
tests \
win32 \
xdgmime \
gappinfoprivate.h \
gapplicationimpl.h \
gasynchelper.h \
gcontenttypeprivate.h \
gcredentialsprivate.h \
gdbus-daemon-generated.h \
gdbusactiongroup-private.h \
gdbusauth.h \
gdbusauthmechanismanon.h \
gdbusauthmechanismexternal.h \
gdbusauthmechanism.h \
gdbusauthmechanismsha1.h \
gdbusdaemon.h \
gdbusprivate.h \
gdelayedsettingsbackend.h \
gdummyfile.h \
@ -45,6 +51,8 @@ IGNORE_HFILES = \
gfileattribute-priv.h \
gfileinfo-priv.h \
giomodule-priv.h \
gioprivate.h \
giowin32-priv.h \
glocaldirectorymonitor.h \
glocalfileenumerator.h \
glocalfile.h \
@ -59,10 +67,12 @@ IGNORE_HFILES = \
gnetworkingprivate.h \
gnetworkmonitorbase.h \
gnetworkmonitornetlink.h \
gnetworkmonitornm.h \
gnotificationbackend.h \
gnotification-private.h \
gpollfilemonitor.h \
gregistrysettingsbackend.h \
gresourcefile.h \
gsettingsbackendinternal.h \
gsettings-mapping.h \
gsettingsschema-internal.h \

111
docs/reference/gio/gio-sections.txt
View File

@ -205,6 +205,13 @@ G_FILE
G_IS_FILE
G_TYPE_FILE
G_FILE_GET_IFACE
G_TYPE_FILESYSTEM_PREVIEW_TYPE
G_TYPE_FILE_COPY_FLAGS
G_TYPE_FILE_CREATE_FLAGS
G_TYPE_FILE_MEASURE_FLAGS
G_TYPE_FILE_MONITOR_EVENT
G_TYPE_FILE_MONITOR_FLAGS
G_TYPE_FILE_QUERY_INFO_FLAGS
<SUBSECTION Private>
g_file_get_type
</SECTION>
@ -402,6 +409,7 @@ G_FILE_INFO_CLASS
G_IS_FILE_INFO_CLASS
G_FILE_INFO_GET_CLASS
g_file_attribute_matcher_get_type
G_TYPE_FILE_TYPE
<SUBSECTION Private>
g_file_info_get_type
</SECTION>
@ -420,6 +428,12 @@ g_file_attribute_info_list_unref
g_file_attribute_info_list_dup
g_file_attribute_info_list_lookup
g_file_attribute_info_list_add
<SUBSECTION Standard>
G_TYPE_FILE_ATTRIBUTE_INFO_FLAGS
G_TYPE_FILE_ATTRIBUTE_INFO_LIST
G_TYPE_FILE_ATTRIBUTE_MATCHER
G_TYPE_FILE_ATTRIBUTE_STATUS
G_TYPE_FILE_ATTRIBUTE_TYPE
<SUBSECTION Private>
g_file_attribute_info_list_get_type
</SECTION>
@ -556,6 +570,7 @@ G_IS_EMBLEMED_ICON_CLASS
G_TYPE_EMBLEMED_ICON
<SUBSECTION Private>
GEmblemedIconPrivate
g_emblemed_icon_get_type
</SECTION>
@ -577,6 +592,7 @@ G_EMBLEM_GET_CLASS
G_IS_EMBLEM
G_IS_EMBLEM_CLASS
G_TYPE_EMBLEM
G_TYPE_EMBLEM_ORIGIN
</SECTION>
<SECTION>
@ -755,6 +771,8 @@ G_TYPE_DATA_INPUT_STREAM
G_DATA_INPUT_STREAM_CLASS
G_IS_DATA_INPUT_STREAM_CLASS
G_DATA_INPUT_STREAM_GET_CLASS
G_TYPE_DATA_STREAM_BYTE_ORDER
G_TYPE_DATA_STREAM_NEWLINE_TYPE
<SUBSECTION Private>
g_data_input_stream_get_type
GDataInputStreamPrivate
@ -826,6 +844,7 @@ G_TYPE_OUTPUT_STREAM
G_OUTPUT_STREAM_CLASS
G_IS_OUTPUT_STREAM_CLASS
G_OUTPUT_STREAM_GET_CLASS
G_TYPE_OUTPUT_STREAM_SPLICE_FLAGS
<SUBSECTION Private>
g_output_stream_get_type
GOutputStreamPrivate
@ -1013,8 +1032,10 @@ G_IO_STREAM_GET_CLASS
G_IS_IO_STREAM
G_IS_IO_STREAM_CLASS
G_TYPE_IO_STREAM
G_TYPE_IO_STREAM_SPLICE_FLAGS
<SUBSECTION Private>
GIOStreamPrivate
GIOStreamAdapter
g_io_stream_get_type
</SECTION>
@ -1121,6 +1142,8 @@ G_IS_MOUNT
G_MOUNT
G_MOUNT_GET_IFACE
G_TYPE_MOUNT
G_TYPE_MOUNT_MOUNT_FLAGS
G_TYPE_MOUNT_UNMOUNT_FLAGS
<SUBSECTION Private>
g_mount_get_type
</SECTION>
@ -1203,6 +1226,8 @@ G_DRIVE
G_IS_DRIVE
G_TYPE_DRIVE
G_DRIVE_GET_IFACE
G_TYPE_DRIVE_START_FLAGS
G_TYPE_DRIVE_START_STOP_TYPE
<SUBSECTION Private>
g_drive_get_type
</SECTION>
@ -1318,6 +1343,8 @@ G_IO_ERROR
GIOErrorEnum
g_io_error_from_errno
g_io_error_from_win32_error
<SUBSECTION Standard>
G_TYPE_IO_ERROR_ENUM
<SUBSECTION Private>
g_io_error_quark
</SECTION>
@ -1398,6 +1425,7 @@ G_APP_LAUNCH_CONTEXT_GET_CLASS
G_IS_APP_LAUNCH_CONTEXT
G_IS_APP_LAUNCH_CONTEXT_CLASS
G_TYPE_APP_LAUNCH_CONTEXT
G_TYPE_APP_INFO_CREATE_FLAGS
<SUBSECTION Private>
g_app_info_get_type
g_app_info_create_flags_get_type
@ -1414,6 +1442,7 @@ g_app_info_monitor_get
GAppInfoMonitor
G_APP_INFO_MONITOR
G_IS_APP_INFO_MONITOR
G_TYPE_APP_INFO_MONITOR
<SUBSECTION Private>
g_app_info_monitor_get_type
</SECTION>
@ -1447,6 +1476,9 @@ G_TYPE_MOUNT_OPERATION
G_MOUNT_OPERATION_CLASS
G_IS_MOUNT_OPERATION_CLASS
G_MOUNT_OPERATION_GET_CLASS
G_TYPE_ASK_PASSWORD_FLAGS
G_TYPE_MOUNT_OPERATION_RESULT
G_TYPE_PASSWORD_SAVE
<SUBSECTION Private>
g_mount_operation_get_type
g_ask_password_flags_get_type
@ -1551,6 +1583,10 @@ g_desktop_app_info_launch_action
<SUBSECTION>
g_desktop_app_info_search
g_desktop_app_info_get_implementations
<SUBSECTION>
GDesktopAppInfoLookup
GDesktopAppInfoLookupIface
G_DESKTOP_APP_INFO_LOOKUP_EXTENSION_POINT_NAME
<SUBSECTION Standard>
GDesktopAppInfoClass
G_TYPE_DESKTOP_APP_INFO
@ -1559,6 +1595,10 @@ G_DESKTOP_APP_INFO_CLASS
G_IS_DESKTOP_APP_INFO
G_IS_DESKTOP_APP_INFO_CLASS
G_DESKTOP_APP_INFO_GET_CLASS
G_DESKTOP_APP_INFO_LOOKUP
G_DESKTOP_APP_INFO_LOOKUP_GET_IFACE
G_IS_DESKTOP_APP_INFO_LOOKUP
G_TYPE_DESKTOP_APP_INFO_LOOKUP
<SUBSECTION Private>
g_desktop_app_info_get_type
g_desktop_app_info_lookup_get_default_for_uri_scheme
@ -1590,6 +1630,7 @@ G_IO_TYPE_MODULE
G_IO_MODULE_CLASS
G_IO_IS_MODULE_CLASS
G_IO_MODULE_GET_CLASS
G_TYPE_IO_MODULE_SCOPE_FLAGS
<SUBSECTION Private>
g_io_module_get_type
</SECTION>
@ -1714,6 +1755,7 @@ G_SOCKET_ADDRESS
G_SOCKET_ADDRESS_CLASS
G_SOCKET_ADDRESS_GET_CLASS
G_TYPE_SOCKET_ADDRESS
G_TYPE_SOCKET_FAMILY
<SUBSECTION Private>
g_socket_address_get_type
</SECTION>
@ -1763,6 +1805,7 @@ G_TYPE_UNIX_SOCKET_ADDRESS
G_UNIX_SOCKET_ADDRESS
G_UNIX_SOCKET_ADDRESS_CLASS
G_UNIX_SOCKET_ADDRESS_GET_CLASS
G_TYPE_UNIX_SOCKET_ADDRESS_TYPE
<SUBSECTION Private>
g_unix_socket_address_get_type
</SECTION>
@ -1784,6 +1827,8 @@ g_resolver_lookup_service
g_resolver_lookup_service_async
g_resolver_lookup_service_finish
g_resolver_free_targets
<SUBSECTION>
GResolverRecordType
g_resolver_lookup_records
g_resolver_lookup_records_async
g_resolver_lookup_records_finish
@ -1800,6 +1845,8 @@ G_RESOLVER
G_RESOLVER_CLASS
G_RESOLVER_GET_CLASS
G_TYPE_RESOLVER
G_TYPE_RESOLVER_ERROR
G_TYPE_RESOLVER_RECORD_TYPE
<SUBSECTION Private>
GResolverPrivate
@ -1923,6 +1970,7 @@ GSocketProtocol
GSocketMsgFlags
GInputVector
GOutputVector
GOutputMessage
g_socket_new
g_socket_new_from_fd
g_socket_bind
@ -1985,6 +2033,9 @@ G_SOCKET
G_SOCKET_CLASS
G_TYPE_SOCKET
G_SOCKET_GET_CLASS
G_TYPE_SOCKET_MSG_FLAGS
G_TYPE_SOCKET_PROTOCOL
G_TYPE_SOCKET_TYPE
<SUBSECTION Private>
g_socket_get_type
GSocketPrivate
@ -2035,6 +2086,7 @@ G_SOCKET_CLIENT
G_SOCKET_CLIENT_CLASS
G_SOCKET_CLIENT_GET_CLASS
G_TYPE_SOCKET_CLIENT
G_TYPE_SOCKET_CLIENT_EVENT
<SUBSECTION Private>
GSocketClientPrivate
g_socket_client_get_type
@ -2259,6 +2311,8 @@ G_TYPE_CONVERTER
G_CONVERTER
G_IS_CONVERTER
G_CONVERTER_GET_IFACE
G_TYPE_CONVERTER_FLAGS
G_TYPE_CONVERTER_RESULT
<SUBSECTION Private>
g_converter_get_type
g_converter_flags_get_type
@ -2339,6 +2393,7 @@ G_IS_ZLIB_COMPRESSOR
G_ZLIB_COMPRESSOR_CLASS
G_IS_ZLIB_COMPRESSOR_CLASS
G_ZLIB_COMPRESSOR_GET_CLASS
G_TYPE_ZLIB_COMPRESSOR_FORMAT
<SUBSECTION Private>
g_zlib_compressor_get_type
</SECTION>
@ -2365,9 +2420,8 @@ g_zlib_decompressor_get_type
<FILE>gfiledescriptorbased</FILE>
<TITLE>GFileDescriptorBased</TITLE>
GFileDescriptorBased
g_file_descriptor_based_get_fd
<SUBSECTION Standard>
GFileDescriptorBasedIface
g_file_descriptor_based_get_fd
<SUBSECTION Private>
g_file_descriptor_based_get_type
G_FILE_DESCRIPTOR_BASED
@ -2411,7 +2465,6 @@ GSettingsBackendPrivate
<FILE>gsettingsschema</FILE>
<TITLE>GSettingsSchema, GSettingsSchemaSource</TITLE>
GSettingsSchemaSource
G_TYPE_SETTINGS_SCHEMA_SOURCE
g_settings_schema_source_get_default
g_settings_schema_source_ref
g_settings_schema_source_unref
@ -2425,7 +2478,6 @@ g_settings_schema_source_lookup
<SUBSECTION>
GSettingsSchema
G_TYPE_SETTINGS_SCHEMA
g_settings_schema_ref
g_settings_schema_unref
@ -2452,6 +2504,11 @@ g_settings_schema_key_get_name
g_settings_schema_key_get_summary
g_settings_schema_key_get_description
<SUBSECTION Standard>
G_TYPE_SETTINGS_SCHEMA_KEY
G_TYPE_SETTINGS_SCHEMA
G_TYPE_SETTINGS_SCHEMA_SOURCE
<SUBSECTION Private>
g_settings_schema_get_type
g_settings_schema_key_get_type
@ -2532,6 +2589,7 @@ G_SETTINGS
G_SETTINGS_CLASS
G_SETTINGS_GET_CLASS
G_TYPE_SETTINGS
G_TYPE_SETTINGS_BIND_FLAGS
<SUBSECTION Private>
GSettingsPrivate
@ -2579,6 +2637,7 @@ G_TYPE_CREDENTIALS
G_CREDENTIALS_CLASS
G_IS_CREDENTIALS_CLASS
G_CREDENTIALS_GET_CLASS
G_TYPE_CREDENTIALS_TYPE
<SUBSECTION Private>
g_credentials_get_type
g_credentials_type_get_type
@ -2648,6 +2707,7 @@ g_dbus_server_get_client_address
G_DBUS_SERVER
G_IS_DBUS_SERVER
G_TYPE_DBUS_SERVER
G_TYPE_DBUS_SERVER_FLAGS
<SUBSECTION Private>
g_dbus_server_get_type
</SECTION>
@ -2713,6 +2773,10 @@ g_dbus_message_to_gerror
G_DBUS_MESSAGE
G_IS_DBUS_MESSAGE
G_TYPE_DBUS_MESSAGE
G_TYPE_DBUS_MESSAGE_BYTE_ORDER
G_TYPE_DBUS_MESSAGE_FLAGS
G_TYPE_DBUS_MESSAGE_HEADER_FIELD
G_TYPE_DBUS_MESSAGE_TYPE
<SUBSECTION Private>
g_dbus_message_get_type
</SECTION>
@ -2786,6 +2850,13 @@ g_dbus_connection_unregister_subtree
G_DBUS_CONNECTION
G_IS_DBUS_CONNECTION
G_TYPE_DBUS_CONNECTION
G_TYPE_BUS_TYPE
G_TYPE_DBUS_CALL_FLAGS
G_TYPE_DBUS_CAPABILITY_FLAGS
G_TYPE_DBUS_CONNECTION_FLAGS
G_TYPE_DBUS_SEND_MESSAGE_FLAGS
G_TYPE_DBUS_SIGNAL_FLAGS
G_TYPE_DBUS_SUBTREE_FLAGS
<SUBSECTION Private>
g_dbus_connection_get_type
g_bus_type_get_type
@ -2833,6 +2904,8 @@ g_bus_unown_name
g_bus_own_name_with_closures
g_bus_own_name_on_connection_with_closures
<SUBSECTION Standard>
G_TYPE_BUS_NAME_OWNER_FLAGS
<SUBSECTION Private>
g_bus_name_owner_flags_get_type
</SECTION>
@ -2848,6 +2921,8 @@ g_bus_unwatch_name
g_bus_watch_name_with_closures
g_bus_watch_name_on_connection_with_closures
<SUBSECTION Standard>
G_TYPE_BUS_NAME_WATCHER_FLAGS
<SUBSECTION Private>
g_bus_name_watcher_flags_get_type
</SECTION>
@ -2868,6 +2943,7 @@ g_dbus_error_set_dbus_error
g_dbus_error_set_dbus_error_valist
g_dbus_error_encode_gerror
<SUBSECTION Standard>
G_TYPE_DBUS_ERROR
g_dbus_error_quark
</SECTION>
@ -2909,6 +2985,7 @@ G_TYPE_DBUS_PROXY
G_DBUS_PROXY_CLASS
G_IS_DBUS_PROXY_CLASS
G_DBUS_PROXY_GET_CLASS
G_TYPE_DBUS_PROXY_FLAGS
<SUBSECTION Private>
GDBusProxyPrivate
g_dbus_proxy_get_type
@ -2955,6 +3032,8 @@ g_dbus_signal_info_unref
g_dbus_property_info_unref
g_dbus_arg_info_unref
g_dbus_annotation_info_unref
<SUBSECTION Standard>
G_TYPE_DBUS_PROPERTY_INFO_FLAGS
<SUBSECTION Private>
g_dbus_annotation_info_get_type
g_dbus_arg_info_get_type
@ -3064,6 +3143,7 @@ G_APPLICATION_CLASS
G_IS_APPLICATION
G_IS_APPLICATION_CLASS
G_APPLICATION_GET_CLASS
G_TYPE_APPLICATION_FLAGS
<SUBSECTION Private>
GApplicationPrivate
g_application_get_type
@ -3176,6 +3256,7 @@ G_TYPE_REMOTE_ACTION_GROUP
G_REMOTE_ACTION_GROUP
G_IS_REMOTE_ACTION_GROUP
G_REMOTE_ACTION_GROUP_GET_IFACE
g_remote_action_group_get_type
</SECTION>
<SECTION>
@ -3418,6 +3499,10 @@ GTlsError
<SUBSECTION>
GTlsAuthenticationMode
GTlsCertificateFlags
<SUBSECTION Standard>
G_TYPE_TLS_AUTHENTICATION_MODE
G_TYPE_TLS_CERTIFICATE_FLAGS
G_TYPE_TLS_ERROR
</SECTION>
<SECTION>
@ -3501,6 +3586,7 @@ G_TLS_CONNECTION
G_TLS_CONNECTION_CLASS
G_TLS_CONNECTION_GET_CLASS
G_TYPE_TLS_CONNECTION
G_TYPE_TLS_REHANDSHAKE_MODE
<SUBSECTION Private>
g_tls_connection_get_type
</SECTION>
@ -3617,6 +3703,11 @@ G_IS_TLS_PASSWORD
G_TLS_PASSWORD
G_TYPE_TLS_PASSWORD
G_TYPE_TLS_PASSWORD_FLAGS
G_TLS_PASSWORD_CLASS
G_TLS_PASSWORD_GET_CLASS
G_IS_TLS_PASSWORD_CLASS
<SUBSECTION Private>
GTlsPasswordPrivate
</SECTION>
<SECTION>
@ -3642,6 +3733,7 @@ G_TLS_INTERACTION
G_TLS_INTERACTION_CLASS
G_TLS_INTERACTION_GET_CLASS
G_TYPE_TLS_INTERACTION_RESULT
G_TYPE_TLS_CERTIFICATE_REQUEST_FLAGS
<SUBSECTION Private>
GTlsInteractionPrivate
g_tls_interaction_get_type
@ -3844,6 +3936,7 @@ GNetworkConnectivity
g_network_monitor_get_connectivity
<SUBSECTION Standard>
g_network_monitor_get_type
G_TYPE_NETWORK_CONNECTIVITY
G_TYPE_NETWORK_MONITOR
G_NETWORK_MONITOR
G_IS_NETWORK_MONITOR
@ -3864,7 +3957,7 @@ g_dbus_menu_model_get
<SUBSECTION Standard>
G_TYPE_DBUS_MENU_MODEL
G_DBUS_MENU_MODEL
G_IS_BDUS_MENU_MODEL
G_IS_DBUS_MENU_MODEL
<SUBSECTION Private>
g_dbus_menu_model_get_type
@ -3946,6 +4039,7 @@ g_menu_model_get_n_items
<SUBSECTION>
G_MENU_ATTRIBUTE_ACTION
G_MENU_ATTRIBUTE_ACTION_NAMESPACE
G_MENU_ATTRIBUTE_TARGET
G_MENU_ATTRIBUTE_LABEL
G_MENU_ATTRIBUTE_ICON
@ -4031,6 +4125,7 @@ g_resource_enumerate_children
g_resource_get_info
<SUBSECTION Static>
GStaticResource
g_static_resource_init
g_static_resource_fini
g_static_resource_get_resource
@ -4078,6 +4173,11 @@ g_test_dbus_unset
<SUBSECTION Private>
g_test_dbus_get_type
g_test_dbus_flags_get_type
<SUBSECTION Standard>
G_TEST_DBUS
G_IS_TEST_DBUS
G_TYPE_TEST_DBUS
G_TYPE_TEST_DBUS_FLAGS
</SECTION>
<SECTION>
@ -4257,6 +4357,7 @@ G_NOTIFICATION
G_TYPE_NOTIFICATION
G_TYPE_NOTIFICATION_BACKEND
g_notification_get_type
G_TYPE_NOTIFICATION_PRIORITY
</SECTION>
<SECTION>

1
gio/fen/fen-kernel.c
View File

@ -301,7 +301,6 @@ psource_new()
/**
* port_add:
* @f:
*
* Unsafe, need lock fen_lock.
* port_add will associate a GSource to @f->source

7
gio/gaction.c
View File

@ -62,6 +62,13 @@ G_DEFINE_INTERFACE (GAction, g_action, G_TYPE_OBJECT)
* inside of a #GSimpleActionGroup.
**/
/**
* GAction:
*
* #GAction is an opaque data structure and can only be accessed
* using the following functions.
**/
/**
* GActionInterface:
* @get_name: the virtual function pointer for g_action_get_name()

7
gio/gactiongroup.c
View File

@ -76,6 +76,13 @@
* calls to g_action_group_query_action().
*/
/**
* GActionGroup:
*
* #GActionGroup is an opaque data structure and can only be accessed
* using the following functions.
**/
/**
* GActionGroupInterface:
* @has_action: the virtual function pointer for g_action_group_has_action()

7
gio/gactionmap.c
View File

@ -42,6 +42,13 @@
* Since: 2.32
**/
/**
* GActionMap:
*
* #GActionMap is an opaque data structure and can only be accessed
* using the following functions.
**/
/**
* GActionMapInterface:
* @lookup_action: the virtual function pointer for g_action_map_lookup_action()

10
gio/gappinfo.c
View File

@ -825,7 +825,7 @@ g_app_launch_context_class_init (GAppLaunchContextClass *klass)
object_class->finalize = g_app_launch_context_finalize;
/*
/**
* GAppLaunchContext::launch-failed:
* @context: the object emitting the signal
* @startup_notify_id: the startup notification id for the failed launch
@ -843,7 +843,7 @@ g_app_launch_context_class_init (GAppLaunchContextClass *klass)
NULL, NULL, NULL,
G_TYPE_NONE, 1, G_TYPE_STRING);
/*
/**
* GAppLaunchContext::launched:
* @context: the object emitting the signal
* @info: the #GAppInfo that was just launched
@ -1132,6 +1132,12 @@ g_app_info_monitor_class_init (GAppInfoMonitorClass *class)
{
GObjectClass *object_class = G_OBJECT_CLASS (class);
/**
* GAppInfoMonitor::changed:
*
* Signal emitted when the app info database for changes (ie: newly installed
* or removed applications).
**/
g_app_info_monitor_changed_signal = g_signal_new ("changed", G_TYPE_APP_INFO_MONITOR, G_SIGNAL_RUN_FIRST,
0, NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);

1
gio/gappinfo.h
View File

@ -78,6 +78,7 @@ typedef struct _GAppLaunchContextPrivate GAppLaunchContextPrivate;
* @get_commandline: Gets the commandline for the #GAppInfo. Since 2.20
* @get_display_name: Gets the display name for the #GAppInfo. Since 2.24
* @set_as_last_used_for_type: Sets the application as the last used. See g_app_info_set_as_last_used_for_type().
* @get_supported_types: Retrieves the list of content types that @app_info claims to support.
*
* Application Information interface, for operating system portability.
*/

10
gio/gapplication.c
View File

@ -163,6 +163,14 @@
* [gapplication-example-dbushooks.c](https://git.gnome.org/browse/glib/tree/gio/tests/gapplication-example-dbushooks.c).
*/
/**
* GApplication:
*
* #GApplication is an opaque data structure and can only be accessed
* using the following functions.
* Since: 2.28
*/
/**
* GApplicationClass:
* @startup: invoked on the primary instance immediately after registration
@ -202,6 +210,8 @@
* @dbus_unregister: invoked locally during unregistration, if the application
* is using its D-Bus backend. Use this to undo anything done by the
* @dbus_register vfunc. Since: 2.34
* @handle_local_options: invoked locally after the parsing of the commandline
* options has occurred.
*
* Virtual function table for #GApplication.
*

5
gio/gapplication.h
View File

@ -41,11 +41,6 @@ G_BEGIN_DECLS
typedef struct _GApplicationPrivate GApplicationPrivate;
typedef struct _GApplicationClass GApplicationClass;
/**
* GApplication:
*
* Since: 2.28
*/
struct _GApplication
{
/*< private >*/

7
gio/gapplicationcommandline.c
View File

@ -200,6 +200,13 @@
* [gapplication-example-cmdline3.c](https://git.gnome.org/browse/glib/tree/gio/tests/gapplication-example-cmdline3.c)
*/
/**
* GApplicationCommandLine:
*
* #GApplicationCommandLine is an opaque data structure and can only be accessed
* using the following functions.
*/
/**
* GApplicationCommandLineClass:
*

7
gio/gdbusactiongroup.c
View File

@ -38,6 +38,13 @@
* that is exported over D-Bus with g_dbus_connection_export_action_group().
*/
/**
* GDBusActionGroup:
*
* #GDBusActionGroup is an opaque data structure and can only be accessed
* using the following functions.
*/
struct _GDBusActionGroup
{
GObject parent_instance;

7
gio/gdbusmenumodel.c
View File

@ -37,6 +37,13 @@
* g_dbus_connection_export_menu_model().
*/
/**
* GDBusMenuModel:
*
* #GDBusMenuModel is an opaque data structure and can only be accessed
* using the following functions.
*/
/*
* There are 3 main (quasi-)classes involved here:
*

7
gio/gdbusobject.c
View File

@ -37,6 +37,13 @@
* interfaces.
*/
/**
* GDBusObject:
*
* #GDBusObject is an opaque data structure and can only be accessed
* using the following functions.
*/
typedef GDBusObjectIface GDBusObjectInterface;
G_DEFINE_INTERFACE (GDBusObject, g_dbus_object, G_TYPE_OBJECT)

7
gio/gdbusobjectmanager.c
View File

@ -41,6 +41,13 @@
* and #GDBusObjectManagerServer for the service-side implementation.
*/
/**
* GDBusObjectManager:
*
* #GDBusObjectManager is an opaque data structure and can only be accessed
* using the following functions.
*/
typedef GDBusObjectManagerIface GDBusObjectManagerInterface;
G_DEFINE_INTERFACE (GDBusObjectManager, g_dbus_object_manager, G_TYPE_OBJECT)

7
gio/gdesktopappinfo.c
View File

@ -4308,6 +4308,13 @@ g_app_info_get_all (void)
/* GDesktopAppInfoLookup interface {{{2 */
/**
* GDesktopAppInfoLookup:
*
* #GDesktopAppInfoLookup is an opaque data structure and can only be accessed
* using the following functions.
**/
G_GNUC_BEGIN_IGNORE_DEPRECATIONS
typedef GDesktopAppInfoLookupIface GDesktopAppInfoLookupInterface;

4
gio/gdesktopappinfo.h
View File

@ -116,7 +116,9 @@ gchar * g_desktop_app_info_get_action_name (GDeskto
#endif /* G_DISABLE_DEPRECATED */
/**
* GDesktopAppInfoLookup:
* GDesktopAppInfoLookupIface:
* @get_default_for_uri_scheme: Virtual method for
* g_desktop_app_info_lookup_get_default_for_uri_scheme().
*
* Interface that is used by backends to associate default
* handlers with URI schemes.

3
gio/gfile.h
View File

@ -150,6 +150,9 @@ typedef struct _GFileIface GFileIface;
* @eject_mountable_with_operation_finish: Finishes an eject operation using a #GMountOperation. Since 2.22.
* @poll_mountable: Polls a mountable object for media changes. Since 2.22.
* @poll_mountable_finish: Finishes an poll operation for media changes. Since 2.22.
* @measure_disk_usage: Recursively measures the disk usage of @file. Since 2.38
* @measure_disk_usage_async: Asynchronously recursively measures the disk usage of @file. Since 2.38
* @measure_disk_usage_finish: Finishes an asynchronous recursive measurement of the disk usage of @file. Since 2.38
*
* An interface for writing VFS file handles.
**/

2
gio/gfiledescriptorbased.h
View File

@ -41,7 +41,9 @@ typedef struct _GFileDescriptorBasedIface GFileDescriptorBasedIface;
/**
* GFileDescriptorBasedIface:
* @g_iface: The parent interface.
* @get_fd: Gets the underlying file descriptor.
*
* An interface for file descriptor based io objects.
**/
struct _GFileDescriptorBasedIface
{

4
gio/gfileinfo.h
View File

@ -826,7 +826,7 @@ typedef struct _GFileInfoClass GFileInfoClass;
* was trashed. Corresponding #GFileAttributeType is
* %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING.
*
* Since: 2.24.
* Since: 2.24
**/
#define G_FILE_ATTRIBUTE_TRASH_ORIG_PATH "trash::orig-path" /* byte string */
@ -838,7 +838,7 @@ typedef struct _GFileInfoClass GFileInfoClass;
* was trashed. The format of the returned string is YYYY-MM-DDThh:mm:ss.
* Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING.
*
* Since: 2.24.
* Since: 2.24
**/
#define G_FILE_ATTRIBUTE_TRASH_DELETION_DATE "trash::deletion-date" /* string */

1
gio/gicon.h
View File

@ -52,6 +52,7 @@ typedef struct _GIconIface GIconIface;
* @from_tokens: Constructs a #GIcon from tokens. Set the #GError if
* the tokens are malformed. Don't implement if the #GIcon can't be
* serialized (Since 2.20).
* @serialize: Serializes a #GIcon into a #GVariant. Since: 2.38
*
* GIconIface is used to implement GIcon types for various
* different systems. See #GThemedIcon and #GLoadableIcon for

12
gio/giomodule.c
View File

@ -224,12 +224,24 @@ static void g_io_module_finalize (GObject *object);
static gboolean g_io_module_load_module (GTypeModule *gmodule);
static void g_io_module_unload_module (GTypeModule *gmodule);
/**
* GIOExtension:
*
* #GIOExtension is an opaque data structure and can only be accessed
* using the following functions.
*/
struct _GIOExtension {
char *name;
GType type;
gint priority;
};
/**
* GIOExtensionPoint:
*
* #GIOExtensionPoint is an opaque data structure and can only be accessed
* using the following functions.
*/
struct _GIOExtensionPoint {
GType required_type;
char *name;

16
gio/gnetworkmonitor.c
View File

@ -48,6 +48,22 @@
* Since: 2.32
*/
/**
* GNetworkMonitorInterface:
* @g_iface: The parent interface.
* @network_changed: the virtual function pointer for the
* GNetworkMonitor::network-changed signal.
* @can_reach: the virtual function pointer for g_network_monitor_can_reach()
* @can_reach_async: the virtual function pointer for
* g_network_monitor_can_reach_async()
* @can_reach_finish: the virtual function pointer for
* g_network_monitor_can_reach_finish()
*
* The virtual function table for #GNetworkMonitor.
*
* Since: 2.32
*/
G_DEFINE_INTERFACE_WITH_CODE (GNetworkMonitor, g_network_monitor, G_TYPE_OBJECT,
g_type_interface_add_prerequisite (g_define_type_id, G_TYPE_INITABLE);)

8
gio/gproxyaddress.c
View File

@ -43,6 +43,14 @@
* Since: 2.26
**/
/**
* GProxyAddressClass:
*
* Class structure for #GProxyAddress.
*
* Since: 2.26
**/
enum
{
PROP_0,

13
gio/gproxyresolver.c
View File

@ -41,6 +41,19 @@
* the method g_socket_connectable_proxy_enumerate().
*/
/**
* GProxyResolverInterface:
* @g_iface: The parent interface.
* @is_supported: the virtual function pointer for g_proxy_resolver_is_supported()
* @lookup: the virtual function pointer for g_proxy_resolver_lookup()
* @lookup_async: the virtual function pointer for
* g_proxy_resolver_lookup_async()
* @lookup_finish: the virtual function pointer for
* g_proxy_resolver_lookup_finish()
*
* The virtual function table for #GProxyResolver.
*/
G_DEFINE_INTERFACE (GProxyResolver, g_proxy_resolver, G_TYPE_OBJECT)
static void

7
gio/gremoteactiongroup.c
View File

@ -55,6 +55,13 @@
* Since: 2.32
**/
/**
* GRemoteActionGroup:
*
* #GRemoteActionGroup is an opaque data structure and can only be accessed
* using the following functions.
**/
/**
* GRemoteActionGroupInterface:
* @activate_action_full: the virtual function pointer for g_remote_action_group_activate_action_full()

7
gio/gresource.c
View File

@ -129,6 +129,13 @@ G_DEFINE_BOXED_TYPE (GResource, g_resource, g_resource_ref, g_resource_unref)
* Since: 2.32
*/
/**
* GStaticResource:
*
* #GStaticResource is an opaque data structure and can only be accessed
* using the following functions.
**/
/**
* g_resource_error_quark:
*

7
gio/gsettings.c
View File

@ -230,6 +230,13 @@
* #G_SETTINGS_BIND_NO_SENSITIVITY flag.
*/
/**
* GSettings:
*
* #GSettings is an opaque data structure and can only be accessed
* using the following functions.
**/
struct _GSettingsPrivate
{
/* where the signals go... */

15
gio/gsettingsbackend.h
View File

@ -59,6 +59,21 @@ G_BEGIN_DECLS
typedef struct _GSettingsBackendPrivate GSettingsBackendPrivate;
typedef struct _GSettingsBackendClass GSettingsBackendClass;
/**
* GSettingsBackendClass:
* @read: virtual method to read a key's value
* @get_writable: virtual method to get if a key is writable
* @write: virtual method to change key's value
* @write_tree: virtual method to change a tree of keys
* @reset: virtual method to reset state
* @subscribe: virtual method to subscribe to key changes
* @unsubscribe: virtual method to unsubscribe to key changes
* @sync: virtual method to sync state
* @get_permission: virtual method to get permission of a key
* @read_user_value: virtual method to read user's key value
*
* Class structure for #GSettingsBackend.
*/
struct _GSettingsBackendClass
{
GObjectClass parent_class;

15
gio/gsettingsschema.c
View File

@ -128,6 +128,13 @@
* Since: 2.32
**/
/**
* GSettingsSchemaKey:
*
* #GSettingsSchemaKey is an opaque data structure and can only be accessed
* using the following functions.
**/
/**
* GSettingsSchema:
*
@ -836,13 +843,15 @@ ensure_schema_lists (void)
/**
* g_settings_list_schemas:
*
* <!-- -->
*
* Returns: (element-type utf8) (transfer none): a list of #GSettings
* schemas that are available. The list must not be modified or
* freed.
*
* Since: 2.26
*
* Deprecated:2.40: Use g_settings_schema_source_list_schemas() instead.
* Deprecated: 2.40: Use g_settings_schema_source_list_schemas() instead.
* If you used g_settings_list_schemas() to check for the presence of
* a particular schema, use g_settings_schema_source_lookup() instead
* of your whole loop.
@ -858,13 +867,15 @@ g_settings_list_schemas (void)
/**
* g_settings_list_relocatable_schemas:
*
* <!-- -->
*
* Returns: (element-type utf8) (transfer none): a list of relocatable
* #GSettings schemas that are available. The list must not be
* modified or freed.
*
* Since: 2.28
*
* Deprecated:2.40: Use g_settings_schema_source_list_schemas() instead
* Deprecated: 2.40: Use g_settings_schema_source_list_schemas() instead
**/
const gchar * const *
g_settings_list_relocatable_schemas (void)

8
gio/gsimpleaction.c
View File

@ -36,6 +36,14 @@
*
* See also #GtkAction.
*/
/**
* GSimpleAction:
*
* #GSimpleAction is an opaque data structure and can only be accessed
* using the following functions.
**/
struct _GSimpleAction
{
GObject parent_instance;

2
gio/gsocketcontrolmessage.h
View File

@ -54,6 +54,8 @@ typedef struct _GSocketControlMessageClass GSocketControlMessag
* @get_type: gets the protocol specific type of the message.
* @serialize: Writes out the message data.
* @deserialize: Tries to deserialize a message.
*
* Class structure for #GSocketControlMessage.
**/
struct _GSocketControlMessageClass

2
gio/gsocketlistener.h
View File

@ -52,6 +52,8 @@ typedef struct _GSocketListenerClass GSocketListenerClass
/**
* GSocketListenerClass:
* @changed: virtual method called when the set of socket listened to changes
*
* Class structure for #GSocketListener.
**/
struct _GSocketListenerClass
{

2
gio/gsocketservice.h
View File

@ -49,6 +49,8 @@ typedef struct _GSocketServiceClass GSocketServiceClass;
/**
* GSocketServiceClass:
* @incomming: signal emitted when new connections are accepted
*
* Class structure for #GSocketService.
*/
struct _GSocketServiceClass
{

7
gio/gtcpwrapperconnection.c
View File

@ -35,6 +35,13 @@
* Since: 2.28
*/
/**
* GTcpWrapperConnection:
*
* #GTcpWrapperConnection is an opaque data structure and can only be accessed
* using the following functions.
**/
#include "config.h"
#include "gtcpwrapperconnection.h"

4
gio/gtlsbackend.c
View File

@ -60,6 +60,10 @@
* @title: GTlsBackend
* @short_description: TLS backend implementation
* @include: gio/gio.h
*
* TLS (Transport Layer Security, aka SSL) backend
*
* Since: 2.28
*/
/**

1
gio/gtlscertificate.c
View File

@ -524,7 +524,6 @@ g_tls_certificate_new_from_file (const gchar *file,
/**
* g_tls_certificate_new_from_files:
* @cert_file: file containing one or more PEM-encoded certificates to
* import
* @key_file: file containing a PEM-encoded private key to import

8
gio/gtlsclientconnection.h
View File

@ -34,6 +34,14 @@ G_BEGIN_DECLS
typedef struct _GTlsClientConnectionInterface GTlsClientConnectionInterface;
/**
* GTlsClientConnectionInterface:
* @g_iface: The parent interface.
*
* vtable for a #GTlsClientConnection implementation.
*
* Since: 2.26
*/
struct _GTlsClientConnectionInterface
{
GTypeInterface g_iface;

9
gio/gtlspassword.h
View File

@ -46,6 +46,15 @@ struct _GTlsPassword
GTlsPasswordPrivate *priv;
};
/**
* GTlsPasswordClass:
* @get_value: virtual method for g_tls_password_get_value()
* @set_value: virtual method for g_tls_password_set_value()
* @get_default_warning: virtual method for g_tls_password_get_warning() if no
* value has been set using g_tls_password_set_warning()
*
* Class structure for #GTlsPassword.
*/
struct _GTlsPasswordClass
{
GObjectClass parent_class;

8
gio/gtlsserverconnection.h
View File

@ -42,6 +42,14 @@ G_BEGIN_DECLS
*/
typedef struct _GTlsServerConnectionInterface GTlsServerConnectionInterface;
/**
* GTlsServerConnectionInterface:
* @g_iface: The parent interface.
*
* vtable for a #GTlsServerConnection implementation.
*
* Since: 2.26
*/
struct _GTlsServerConnectionInterface
{
GTypeInterface g_iface;

7
gio/gunixconnection.c
View File

@ -46,6 +46,13 @@
* Since: 2.22
*/
/**
* GUnixConnection:
*
* #GUnixConnection is an opaque data structure and can only be accessed
* using the following functions.
**/
G_DEFINE_TYPE_WITH_CODE (GUnixConnection, g_unix_connection,
G_TYPE_SOCKET_CONNECTION,
g_socket_connection_factory_register_type (g_define_type_id,

7
gio/gunixfdlist.c
View File

@ -31,6 +31,13 @@
* file when using it.
*/
/**
* GUnixFDList:
*
* #GUnixFDList is an opaque data structure and can only be accessed
* using the following functions.
**/
#include "config.h"
#include <unistd.h>

7
gio/gunixfdmessage.c
View File

@ -34,6 +34,13 @@
* file when using it.
*/
/**
* GUnixFDMessage:
*
* #GUnixFDMessage is an opaque data structure and can only be accessed
* using the following functions.
**/
#include "config.h"
#include <unistd.h>

2
gio/gwin32mount.c
View File

@ -117,7 +117,7 @@ _win32_get_displayname (const char *drive)
return name ? name : g_strdup (drive);
}
/**
/*
* _g_win32_mount_new:
* @volume_monitor: a #GVolumeMonitor.
* @path: a win32 path.

2
gio/kqueue/kqueue-exclusions.c
View File

@ -29,7 +29,7 @@
static gboolean ke_debug_enabled = FALSE;
#define KE_W if (ke_debug_enabled) g_warning
/**
/*
* _ke_is_excluded:
* @full_path - a path to file to check.
*

4
gio/kqueue/kqueue-helper.c
View File

@ -428,7 +428,7 @@ process_kqueue_notifications (GIOChannel *gioc,
}
/**
/*
* _kh_startup_impl:
* @unused: unused
*
@ -479,7 +479,7 @@ _kh_startup_impl (gpointer unused)
}
/**
/*
* _kh_startup:
* Kqueue backend initialization.
*

2
gio/win32/gwinhttpfile.c
View File

@ -75,7 +75,7 @@ g_winhttp_file_init (GWinHttpFile *winhttp)
{
}
/**
/*
* _g_winhttp_file_new:
* @vfs: GWinHttpVfs to use
* @uri: URI of the GWinHttpFile to create.

2
gio/win32/gwinhttpfileinputstream.c
View File

@ -92,7 +92,7 @@ g_winhttp_file_input_stream_init (GWinHttpFileInputStream *info)
{
}
/**
/*
* g_winhttp_file_input_stream_new:
* @file: the GWinHttpFile being read
* @connection: handle to the HTTP connection, as from WinHttpConnect()

2
gio/win32/gwinhttpfileoutputstream.c
View File

@ -81,7 +81,7 @@ g_winhttp_file_output_stream_init (GWinHttpFileOutputStream *info)
{
}
/**
/*
* g_winhttp_file_output_stream_new:
* @file: the GWinHttpFile being read
* @connection: handle to the HTTP connection, as from WinHttpConnect()