summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDavid Zeuthen <davidz@redhat.com>2010-05-06 15:31:45 -0400
committerDavid Zeuthen <davidz@redhat.com>2010-05-06 15:31:45 -0400
commitc490c14f4e3fbbe8c74b26e6cacac31b0e744c92 (patch)
treedf9113881a866c54b5ef870900e2bd0ae581257b /docs
parentd0a14469d09d5fe23de219ba293fd4a266b02ced (diff)
Set up gtk-doc for GDBus
Also move send_credentials() and receive_credentials() to GUnixConnection. This code might change, discussion is still ongoing in https://bugzilla.gnome.org/show_bug.cgi?id=617483.
Diffstat (limited to 'docs')
-rw-r--r--docs/reference/gio/gio-docs.xml21
-rw-r--r--docs/reference/gio/gio-sections.txt390
-rw-r--r--docs/reference/gio/gio.types11
3 files changed, 422 insertions, 0 deletions
diff --git a/docs/reference/gio/gio-docs.xml b/docs/reference/gio/gio-docs.xml
index 8ea9f3874..305dc7a07 100644
--- a/docs/reference/gio/gio-docs.xml
+++ b/docs/reference/gio/gio-docs.xml
@@ -107,6 +107,8 @@
<xi:include href="xml/gsocketcontrolmessage.xml"/>
<xi:include href="xml/gunixfdlist.xml"/>
<xi:include href="xml/gunixfdmessage.xml"/>
+ <xi:include href="xml/gcredentials.xml"/>
+ <xi:include href="xml/gunixcredentialsmessage.xml"/>
</chapter>
<chapter id="resolver">
<title>DNS resolution</title>
@@ -124,6 +126,25 @@
<xi:include href="xml/gsocketservice.xml"/>
<xi:include href="xml/gthreadedsocketservice.xml"/>
</chapter>
+ <chapter id="gdbus-lowlevel">
+ <title>Lowlevel D-Bus Support</title>
+ <xi:include href="xml/gdbusutils.xml"/>
+ <xi:include href="xml/gdbusaddress.xml"/>
+ <xi:include href="xml/gdbusintrospection.xml"/>
+ <xi:include href="xml/gdbuserror.xml"/>
+ <xi:include href="xml/gdbusmessage.xml"/>
+ <xi:include href="xml/gdbusconnection.xml"/>
+ <xi:include href="xml/gdbusmethodinvocation.xml"/>
+ <xi:include href="xml/gdbusproxy.xml"/>
+ <xi:include href="xml/gdbusserver.xml"/>
+ <xi:include href="xml/gdbusauthobserver.xml"/>
+ </chapter>
+ <chapter id="gdbus-convenience">
+ <title>Highlevel D-Bus Support</title>
+ <xi:include href="xml/gdbusnameowning.xml"/>
+ <xi:include href="xml/gdbusnamewatching.xml"/>
+ <xi:include href="xml/gdbusproxywatching.xml"/>
+ </chapter>
<chapter id="utils">
<title>Utilities</title>
<xi:include href="xml/gfilenamecompleter.xml"/>
diff --git a/docs/reference/gio/gio-sections.txt b/docs/reference/gio/gio-sections.txt
index fd2c33828..06d81999a 100644
--- a/docs/reference/gio/gio-sections.txt
+++ b/docs/reference/gio/gio-sections.txt
@@ -1807,6 +1807,8 @@ g_tcp_connection_get_graceful_disconnect
GUnixConnection
g_unix_connection_receive_fd
g_unix_connection_send_fd
+g_unix_connection_receive_credentials
+g_unix_connection_send_credentials
<SUBSECTION>
g_socket_connection_factory_create_connection
g_socket_connection_factory_lookup_type
@@ -2167,3 +2169,391 @@ G_SETTINGS_SCHEMA_GET_CLASS
<SUBSECTION Private>
g_settings_get_type
</SECTION>
+
+<SECTION>
+<FILE>gunixcredentialsmessage</FILE>
+<TITLE>GUnixCredentialsMessage</TITLE>
+GUnixCredentialsMessage
+GUnixCredentialsMessageClass
+g_unix_credentials_message_new
+g_unix_credentials_message_new_with_credentials
+g_unix_credentials_message_get_credentials
+g_unix_credentials_message_is_supported
+<SUBSECTION Standard>
+G_IS_UNIX_CREDENTIALS_MESSAGE
+G_IS_UNIX_CREDENTIALS_MESSAGE_CLASS
+G_TYPE_UNIX_CREDENTIALS_MESSAGE
+G_UNIX_CREDENTIALS_MESSAGE
+G_UNIX_CREDENTIALS_MESSAGE_CLASS
+G_UNIX_CREDENTIALS_MESSAGE_GET_CLASS
+<SUBSECTION Private>
+GUnixCredentialsMessagePrivate
+g_unix_credentials_message_get_type
+</SECTION>
+
+<SECTION>
+<FILE>gcredentials</FILE>
+<TITLE>GCredentials</TITLE>
+GCredentials
+GCredentialsClass
+GCredentialType
+g_credentials_new
+g_credentials_new_for_process
+g_credentials_new_for_string
+g_credentials_to_string
+g_credentials_has_unix_user
+g_credentials_get_unix_user
+g_credentials_set_unix_user
+g_credentials_has_unix_group
+g_credentials_get_unix_group
+g_credentials_set_unix_group
+g_credentials_has_unix_process
+g_credentials_get_unix_process
+g_credentials_set_unix_process
+g_credentials_has_windows_user
+g_credentials_get_windows_user
+g_credentials_set_windows_user
+<SUBSECTION Standard>
+G_CREDENTIALS
+G_IS_CREDENTIALS
+G_TYPE_CREDENTIALS
+g_credentials_get_type
+G_CREDENTIALS_CLASS
+G_IS_CREDENTIALS_CLASS
+G_CREDENTIALS_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>gdbusaddress</FILE>
+g_dbus_is_address
+g_dbus_is_supported_address
+g_dbus_address_get_stream
+g_dbus_address_get_stream_finish
+g_dbus_address_get_stream_sync
+g_dbus_address_get_for_bus_sync
+</SECTION>
+
+<SECTION>
+<FILE>gdbusutils</FILE>
+g_dbus_is_activated
+g_dbus_generate_guid
+g_dbus_is_guid
+g_dbus_is_name
+g_dbus_is_unique_name
+g_dbus_is_member_name
+g_dbus_is_interface_name
+</SECTION>
+
+<SECTION>
+<FILE>gdbusauthobserver</FILE>
+<TITLE>GDBusAuthObserver</TITLE>
+GDBusAuthObserver
+GDBusAuthObserverClass
+g_dbus_auth_observer_new
+g_dbus_auth_observer_deny_authenticated_peer
+<SUBSECTION Standard>
+G_DBUS_AUTH_OBSERVER
+G_IS_DBUS_AUTH_OBSERVER
+G_TYPE_DBUS_AUTH_OBSERVER
+g_dbus_server_get_gtype
+G_DBUS_AUTH_OBSERVER_CLASS
+G_IS_DBUS_AUTH_OBSERVER_CLASS
+G_DBUS_AUTH_OBSERVER_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>gdbusserver</FILE>
+<TITLE>GDBusServer</TITLE>
+GDBusServer
+GDBusServerClass
+GDBusServerFlags
+g_dbus_server_new_sync
+g_dbus_server_start
+g_dbus_server_stop
+g_dbus_server_is_active
+g_dbus_server_get_guid
+g_dbus_server_get_flags
+g_dbus_server_get_client_address
+<SUBSECTION Standard>
+G_DBUS_SERVER
+G_IS_DBUS_SERVER
+G_TYPE_DBUS_SERVER
+g_dbus_server_get_gtype
+G_DBUS_SERVER_CLASS
+G_IS_DBUS_SERVER_CLASS
+G_DBUS_SERVER_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>gdbusmessage</FILE>
+<TITLE>GDBusMessage</TITLE>
+GDBusMessageType
+GDBusMessageFlags
+GDBusMessageHeaderField
+GDBusMessage
+GDBusMessageClass
+g_dbus_message_new
+g_dbus_message_new_signal
+g_dbus_message_new_method_call
+g_dbus_message_new_method_reply
+g_dbus_message_new_method_error
+g_dbus_message_new_method_error_valist
+g_dbus_message_new_method_error_literal
+g_dbus_message_print
+g_dbus_message_get_type
+g_dbus_message_set_type
+g_dbus_message_get_serial
+g_dbus_message_set_serial
+g_dbus_message_get_flags
+g_dbus_message_set_flags
+g_dbus_message_get_body
+g_dbus_message_set_body
+g_dbus_message_get_unix_fd_list
+g_dbus_message_set_unix_fd_list
+g_dbus_message_get_header_fields
+g_dbus_message_get_header
+g_dbus_message_set_header
+g_dbus_message_get_destination
+g_dbus_message_set_destination
+g_dbus_message_get_error_name
+g_dbus_message_set_error_name
+g_dbus_message_get_interface
+g_dbus_message_set_interface
+g_dbus_message_get_member
+g_dbus_message_set_member
+g_dbus_message_get_path
+g_dbus_message_set_path
+g_dbus_message_get_reply_serial
+g_dbus_message_set_reply_serial
+g_dbus_message_get_sender
+g_dbus_message_set_sender
+g_dbus_message_get_signature
+g_dbus_message_set_signature
+g_dbus_message_get_arg0
+g_dbus_message_to_blob
+g_dbus_message_bytes_needed
+g_dbus_message_new_from_blob
+g_dbus_message_to_gerror
+<SUBSECTION Standard>
+G_DBUS_MESSAGE
+G_IS_DBUS_MESSAGE
+G_TYPE_DBUS_MESSAGE
+g_dbus_message_get_gtype
+G_DBUS_MESSAGE_CLASS
+G_IS_DBUS_MESSAGE_CLASS
+G_DBUS_MESSAGE_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>gdbusconnection</FILE>
+<TITLE>GDBusConnection</TITLE>
+GBusType
+g_bus_get
+g_bus_get_finish
+g_bus_get_sync
+GDBusConnection
+GDBusConnectionClass
+GDBusConnectionFlags
+g_dbus_connection_new
+g_dbus_connection_new_finish
+g_dbus_connection_new_sync
+g_dbus_connection_new_for_address
+g_dbus_connection_new_for_address_finish
+g_dbus_connection_new_for_address_sync
+GDBusCapabilityFlags
+g_dbus_connection_close
+g_dbus_connection_is_closed
+g_dbus_connection_get_exit_on_close
+g_dbus_connection_set_exit_on_close
+g_dbus_connection_get_stream
+g_dbus_connection_get_guid
+g_dbus_connection_get_unique_name
+g_dbus_connection_get_capabilities
+g_dbus_connection_get_peer_credentials
+GDBusInvokeMethodFlags
+g_dbus_connection_invoke_method
+g_dbus_connection_invoke_method_finish
+g_dbus_connection_invoke_method_sync
+g_dbus_connection_emit_signal
+GDBusSignalCallback
+g_dbus_connection_signal_subscribe
+g_dbus_connection_signal_unsubscribe
+g_dbus_connection_send_message
+g_dbus_connection_send_message_with_reply
+g_dbus_connection_send_message_with_reply_finish
+g_dbus_connection_send_message_with_reply_sync
+GDBusMessageFilterFunction
+g_dbus_connection_add_filter
+g_dbus_connection_remove_filter
+GDBusInterfaceVTable
+GDBusInterfaceMethodCallFunc
+GDBusInterfaceGetPropertyFunc
+GDBusInterfaceSetPropertyFunc
+g_dbus_connection_register_object
+g_dbus_connection_unregister_object
+GDBusSubtreeVTable
+GDBusSubtreeEnumerateFunc
+GDBusSubtreeIntrospectFunc
+GDBusSubtreeDispatchFunc
+GDBusSubtreeFlags
+g_dbus_connection_register_subtree
+g_dbus_connection_unregister_subtree
+<SUBSECTION Standard>
+G_DBUS_CONNECTION
+G_IS_DBUS_CONNECTION
+G_TYPE_DBUS_CONNECTION
+g_dbus_connection_get_type
+G_DBUS_CONNECTION_CLASS
+G_IS_DBUS_CONNECTION_CLASS
+G_DBUS_CONNECTION_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>gdbusmethodinvocation</FILE>
+<TITLE>GDBusMethodInvocation</TITLE>
+GDBusMethodInvocation
+GDBusMethodInvocationClass
+g_dbus_method_invocation_new
+g_dbus_method_invocation_get_sender
+g_dbus_method_invocation_get_object_path
+g_dbus_method_invocation_get_interface_name
+g_dbus_method_invocation_get_method_name
+g_dbus_method_invocation_get_method_info
+g_dbus_method_invocation_get_connection
+g_dbus_method_invocation_get_message
+g_dbus_method_invocation_get_parameters
+g_dbus_method_invocation_get_user_data
+g_dbus_method_invocation_return_value
+g_dbus_method_invocation_return_error
+g_dbus_method_invocation_return_error_valist
+g_dbus_method_invocation_return_error_literal
+g_dbus_method_invocation_return_gerror
+g_dbus_method_invocation_return_dbus_error
+<SUBSECTION Standard>
+G_DBUS_METHOD_INVOCATION
+G_IS_DBUS_METHOD_INVOCATION
+G_TYPE_DBUS_METHOD_INVOCATION
+g_dbus_method_invocation_get_type
+G_DBUS_METHOD_INVOCATION_CLASS
+G_IS_DBUS_METHOD_INVOCATION_CLASS
+G_DBUS_METHOD_INVOCATION_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>gdbusnameowning</FILE>
+GBusAcquiredCallback
+GBusNameAcquiredCallback
+GBusNameLostCallback
+GBusNameOwnerFlags
+g_bus_own_name
+g_bus_own_name_on_connection
+g_bus_unown_name
+</SECTION>
+
+<SECTION>
+<FILE>gdbusnamewatching</FILE>
+GBusNameAppearedCallback
+GBusNameVanishedCallback
+GBusNameWatcherFlags
+g_bus_watch_name
+g_bus_unwatch_name
+</SECTION>
+
+<SECTION>
+<FILE>gdbusproxywatching</FILE>
+GBusProxyAppearedCallback
+GBusProxyVanishedCallback
+g_bus_watch_proxy
+g_bus_unwatch_proxy
+</SECTION>
+
+<SECTION>
+<FILE>gdbuserror</FILE>
+GDBusError
+G_DBUS_ERROR
+g_dbus_error_is_remote_error
+g_dbus_error_get_remote_error
+g_dbus_error_strip_remote_error
+GDBusErrorEntry
+g_dbus_error_register_error_domain
+g_dbus_error_register_error
+g_dbus_error_unregister_error
+g_dbus_error_new_for_dbus_error
+g_dbus_error_set_dbus_error
+g_dbus_error_set_dbus_error_valist
+g_dbus_error_encode_gerror
+</SECTION>
+
+<SECTION>
+<FILE>gdbusproxy</FILE>
+<TITLE>GDBusProxy</TITLE>
+GDBusProxyFlags
+GDBusProxy
+GDBusProxyClass
+g_dbus_proxy_new
+g_dbus_proxy_new_finish
+g_dbus_proxy_new_sync
+g_dbus_proxy_get_flags
+g_dbus_proxy_get_connection
+g_dbus_proxy_get_unique_bus_name
+g_dbus_proxy_get_object_path
+g_dbus_proxy_get_interface_name
+g_dbus_proxy_get_default_timeout
+g_dbus_proxy_set_default_timeout
+g_dbus_proxy_get_cached_property_names
+g_dbus_proxy_get_cached_property
+g_dbus_proxy_set_interface_info
+g_dbus_proxy_get_interface_info
+g_dbus_proxy_invoke_method
+g_dbus_proxy_invoke_method_finish
+g_dbus_proxy_invoke_method_sync
+<SUBSECTION Standard>
+G_DBUS_PROXY
+G_IS_DBUS_PROXY
+G_TYPE_DBUS_PROXY
+g_dbus_proxy_get_type
+G_DBUS_PROXY_CLASS
+G_IS_DBUS_PROXY_CLASS
+G_DBUS_PROXY_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>gdbusintrospection</FILE>
+GDBusAnnotationInfo
+GDBusArgInfo
+GDBusMethodInfo
+GDBusSignalInfo
+GDBusPropertyInfoFlags
+GDBusPropertyInfo
+GDBusInterfaceInfo
+GDBusNodeInfo
+g_dbus_annotation_info_lookup
+g_dbus_interface_info_lookup_method
+g_dbus_interface_info_lookup_signal
+g_dbus_interface_info_lookup_property
+g_dbus_interface_info_generate_xml
+g_dbus_node_info_new_for_xml
+g_dbus_node_info_lookup_interface
+g_dbus_node_info_generate_xml
+G_TYPE_DBUS_NODE_INFO
+G_TYPE_DBUS_INTERFACE_INFO
+G_TYPE_DBUS_METHOD_INFO
+G_TYPE_DBUS_SIGNAL_INFO
+G_TYPE_DBUS_PROPERTY_INFO
+G_TYPE_DBUS_ARG_INFO
+G_TYPE_DBUS_ANNOTATION_INFO
+g_dbus_node_info_ref
+g_dbus_interface_info_ref
+g_dbus_method_info_ref
+g_dbus_signal_info_ref
+g_dbus_property_info_ref
+g_dbus_arg_info_ref
+g_dbus_annotation_info_ref
+g_dbus_node_info_unref
+g_dbus_interface_info_unref
+g_dbus_method_info_unref
+g_dbus_signal_info_unref
+g_dbus_property_info_unref
+g_dbus_arg_info_unref
+g_dbus_annotation_info_unref
+</SECTION>
diff --git a/docs/reference/gio/gio.types b/docs/reference/gio/gio.types
index e8f973822..e1d65a931 100644
--- a/docs/reference/gio/gio.types
+++ b/docs/reference/gio/gio.types
@@ -107,3 +107,14 @@ g_volume_monitor_get_type
g_zlib_compressor_get_type
g_zlib_compressor_format_get_type
g_zlib_decompressor_get_type
+g_dbus_message_get_gtype
+g_dbus_connection_get_type
+g_bus_type_get_type
+g_bus_name_owner_flags_get_type
+g_dbus_error_get_type
+g_dbus_proxy_get_type
+g_dbus_method_invocation_get_type
+g_dbus_server_get_type
+g_dbus_auth_observer_get_type
+g_credentials_get_type
+g_unix_credentials_message_get_type