Commit ac93a6af authored by David Zeuthen's avatar David Zeuthen

Add "Since: 2.30" for new D-Bus routines

Signed-off-by: default avatarDavid Zeuthen <davidz@redhat.com>
parent bf6e10fe
......@@ -56,6 +56,8 @@ g_dbus_interface_default_init (GDBusInterfaceIface *iface)
* implemented by @interface.
*
* Returns: (transfer none): A #GDBusInterfaceInfo. Do not free.
*
* Since: 2.30
*/
GDBusInterfaceInfo *
g_dbus_interface_get_info (GDBusInterface *interface)
......@@ -72,6 +74,8 @@ g_dbus_interface_get_info (GDBusInterface *interface)
*
* Returns: (transfer none): A #GDBusObject or %NULL. The returned
* reference belongs to @interface and should not be freed.
*
* Since: 2.30
*/
GDBusObject *
g_dbus_interface_get_object (GDBusInterface *interface)
......@@ -88,6 +92,8 @@ g_dbus_interface_get_object (GDBusInterface *interface)
* Sets the #GDBusObject for @interface to @object.
*
* Note that @interface will hold a weak reference to @object.
*
* Since: 2.30
*/
void
g_dbus_interface_set_object (GDBusInterface *interface,
......@@ -112,6 +118,8 @@ g_dbus_interface_set_object (GDBusInterface *interface,
* Note that the passed @out_gvalue does not have to have a #GType set.
*
* Returns: %TRUE if the conversion succeeded, %FALSE otherwise.
*
* Since: 2.30
*/
gboolean
g_dbus_gvariant_to_gvalue (GVariant *value,
......@@ -257,6 +265,8 @@ g_dbus_gvariant_to_gvalue (GVariant *value,
*
* Returns: A #GVariant (never floating) holding the data from @gvalue
* or %NULL in case of error. Free with g_variant_unref().
*
* Since: 2.30
*/
GVariant *
g_dbus_gvalue_to_gvariant (const GValue *gvalue,
......
......@@ -36,6 +36,8 @@ G_BEGIN_DECLS
* GDBusInterface:
*
* Base type for D-Bus interfaces.
*
* Since: 2.30
*/
typedef struct _GDBusInterface GDBusInterface; /* Dummy typedef */
......@@ -49,6 +51,8 @@ typedef struct _GDBusInterfaceIface GDBusInterfaceIface;
* @set_object: Sets the enclosing #GDBusObject. See g_dbus_interface_set_object().
*
* Base type for D-Bus interfaces.
*
* Since: 2.30
*/
struct _GDBusInterfaceIface
{
......
......@@ -153,6 +153,8 @@ g_dbus_interface_stub_class_init (GDBusInterfaceStubClass *klass)
* GDBusInterfaceStub:g-flags:
*
* Flags from the #GDBusInterfaceStubFlags enumeration.
*
* Since: 2.30
*/
g_object_class_install_property (gobject_class,
PROP_G_FLAGS,
......@@ -205,6 +207,8 @@ g_dbus_interface_stub_class_init (GDBusInterfaceStubClass *klass)
* to was exported in.
*
* Returns: %TRUE if the call is authorized, %FALSE otherwise.
*
* Since: 2.30
*/
signals[G_AUTHORIZE_METHOD_SIGNAL] =
g_signal_new ("g-authorize-method",
......@@ -237,6 +241,8 @@ g_dbus_interface_stub_init (GDBusInterfaceStub *stub)
* of @stub
*
* Returns: One or more flags from the #GDBusInterfaceStubFlags enumeration.
*
* Since: 2.30
*/
GDBusInterfaceStubFlags
g_dbus_interface_stub_get_flags (GDBusInterfaceStub *stub)
......@@ -251,6 +257,8 @@ g_dbus_interface_stub_get_flags (GDBusInterfaceStub *stub)
* @flags: Flags from the #GDBusInterfaceStubFlags enumeration.
*
* Sets flags describing what the behavior of @stub should be.
*
* Since: 2.30
*/
void
g_dbus_interface_stub_set_flags (GDBusInterfaceStub *stub,
......@@ -272,6 +280,8 @@ g_dbus_interface_stub_set_flags (GDBusInterfaceStub *stub,
* implemented by @interface.
*
* Returns: (transfer none): A #GDBusInterfaceInfo (never %NULL). Do not free.
*
* Since: 2.30
*/
GDBusInterfaceInfo *
g_dbus_interface_stub_get_info (GDBusInterfaceStub *stub)
......@@ -292,6 +302,8 @@ g_dbus_interface_stub_get_info (GDBusInterfaceStub *stub)
* itself to be passed as @user_data.
*
* Returns: A #GDBusInterfaceVTable (never %NULL).
*
* Since: 2.30
*/
GDBusInterfaceVTable *
g_dbus_interface_stub_get_vtable (GDBusInterfaceStub *stub)
......@@ -310,6 +322,8 @@ g_dbus_interface_stub_get_vtable (GDBusInterfaceStub *stub)
* Gets all D-Bus properties for @stub.
*
* Returns: A new, floating, #GVariant. Free with g_variant_unref().
*
* Since: 2.30
*/
GVariant *
g_dbus_interface_stub_get_properties (GDBusInterfaceStub *stub)
......@@ -333,6 +347,8 @@ g_dbus_interface_stub_get_properties (GDBusInterfaceStub *stub)
* <literal>org.freedesktop.DBus.Properties::PropertiesChanged</literal>
* signal later (e.g. in an idle handler). This technique is useful
* for collapsing multiple property changes into one.
*
* Since: 2.30
*/
void
g_dbus_interface_stub_flush (GDBusInterfaceStub *stub)
......@@ -572,6 +588,8 @@ stub_intercept_handle_method_call(GDBusConnection *connection,
*
* Returns: (transfer none): A #GDBusConnection or %NULL if @stub is
* not exported anywhere. Do not free, the object belongs to @stub.
*
* Since: 2.30
*/
GDBusConnection *
g_dbus_interface_stub_get_connection (GDBusInterfaceStub *stub)
......@@ -588,6 +606,8 @@ g_dbus_interface_stub_get_connection (GDBusInterfaceStub *stub)
*
* Returns: A string owned by @stub or %NULL if stub is not exported
* anywhere. Do not free, the string belongs to @stub.
*
* Since: 2.30
*/
const gchar *
g_dbus_interface_stub_get_object_path (GDBusInterfaceStub *stub)
......@@ -609,6 +629,8 @@ g_dbus_interface_stub_get_object_path (GDBusInterfaceStub *stub)
*
* Returns: %TRUE if the interface was exported, other %FALSE with
* @error set.
*
* Since: 2.30
*/
gboolean
g_dbus_interface_stub_export (GDBusInterfaceStub *stub,
......@@ -668,6 +690,8 @@ g_dbus_interface_stub_export (GDBusInterfaceStub *stub,
*
* Stops exporting an interface previously exported with
* g_dbus_interface_stub_export().
*
* Since: 2.30
*/
void
g_dbus_interface_stub_unexport (GDBusInterfaceStub *stub)
......
......@@ -42,6 +42,8 @@ typedef struct _GDBusInterfaceStubPrivate GDBusInterfaceStubPrivate;
*
* The #GDBusInterfaceStub structure contains private data and should
* only be accessed using the provided API.
*
* Since: 2.30
*/
struct _GDBusInterfaceStub
{
......@@ -60,6 +62,8 @@ struct _GDBusInterfaceStub
* @g_authorize_method: Signal class handler for the #GDBusInterfaceStub::g-authorize-method signal.
*
* Class structure for #GDBusInterfaceStub.
*
* Since: 2.30
*/
struct _GDBusInterfaceStubClass
{
......
......@@ -52,6 +52,8 @@ g_dbus_object_default_init (GDBusObjectIface *iface)
* @interface: The #GDBusInterface that was added.
*
* Emitted when @interface is added to @object.
*
* Since: 2.30
*/
g_signal_new ("interface-added",
G_TYPE_FROM_INTERFACE (iface),
......@@ -70,6 +72,8 @@ g_dbus_object_default_init (GDBusObjectIface *iface)
* @interface: The #GDBusInterface that was removed.
*
* Emitted when @interface is removed from @object.
*
* Since: 2.30
*/
g_signal_new ("interface-removed",
G_TYPE_FROM_INTERFACE (iface),
......@@ -92,6 +96,8 @@ g_dbus_object_default_init (GDBusObjectIface *iface)
* Gets the object path for @object.
*
* Returns: A string owned by @object. Do not free.
*
* Since: 2.30
*/
const gchar *
g_dbus_object_get_object_path (GDBusObject *object)
......@@ -109,6 +115,8 @@ g_dbus_object_get_object_path (GDBusObject *object)
* Returns: (element-type GDBusInterface) (transfer full) : A list of #GDBusInterface instances.
* The returned list must be freed by g_list_free() after each element has been freed
* with g_object_unref().
*
* Since: 2.30
*/
GList *
g_dbus_object_get_interfaces (GDBusObject *object)
......@@ -127,6 +135,8 @@ g_dbus_object_get_interfaces (GDBusObject *object)
*
* Returns: %NULL if not found, otherwise a #GDBusInterface that must
* be freed with g_object_unref().
*
* Since: 2.30
*/
GDBusInterface *
g_dbus_object_get_interface (GDBusObject *object,
......@@ -153,6 +163,8 @@ g_dbus_object_get_interface (GDBusObject *object,
* Returns: A #GDBusInterface implementing @type or %NULL if
* not found. Do not free the returned object, it is owned by
* @object.
*
* Since: 2.30
*/
gpointer
g_dbus_object_peek_with_typecheck (GDBusObject *object,
......@@ -178,6 +190,8 @@ g_dbus_object_peek_with_typecheck (GDBusObject *object,
*
* Returns: A #GDBusInterface implementing @type or %NULL if
* not found. Free with g_object_unref().
*
* Since: 2.30
*/
gpointer
g_dbus_object_lookup_with_typecheck (GDBusObject *object,
......
......@@ -51,6 +51,8 @@ typedef struct _GDBusObjectIface GDBusObjectIface;
* <note><para>The @lookup_with_typecheck and @peek_with_typecheck
* virtual functions should only be used by D-Bus interface
* implementations.</para></note>
*
* Since: 2.30
*/
struct _GDBusObjectIface
{
......
......@@ -44,12 +44,6 @@
* and #GDBusObjectManagerServer for the service-side implementation.
*/
/**
* GDBusObjectManager:
*
* A D-Bus object.
*/
typedef GDBusObjectManagerIface GDBusObjectManagerInterface;
G_DEFINE_INTERFACE (GDBusObjectManager, g_dbus_object_manager, G_TYPE_OBJECT)
......@@ -62,6 +56,8 @@ g_dbus_object_manager_default_init (GDBusObjectManagerIface *iface)
* @object: The #GDBusObject that was added.
*
* Emitted when @object is added to @manager.
*
* Since: 2.30
*/
g_signal_new ("object-added",
G_TYPE_FROM_INTERFACE (iface),
......@@ -80,6 +76,8 @@ g_dbus_object_manager_default_init (GDBusObjectManagerIface *iface)
* @object: The #GDBusObject that was removed.
*
* Emitted when @object is removed from @manager.
*
* Since: 2.30
*/
g_signal_new ("object-removed",
G_TYPE_FROM_INTERFACE (iface),
......@@ -102,6 +100,8 @@ g_dbus_object_manager_default_init (GDBusObjectManagerIface *iface)
*
* This signal exists purely as a convenience to avoid having to
* connect signals to all objects managed by @manager.
*
* Since: 2.30
*/
g_signal_new ("interface-added",
G_TYPE_FROM_INTERFACE (iface),
......@@ -125,6 +125,8 @@ g_dbus_object_manager_default_init (GDBusObjectManagerIface *iface)
*
* This signal exists purely as a convenience to avoid having to
* connect signals to all objects managed by @manager.
*
* Since: 2.30
*/
g_signal_new ("interface-removed",
G_TYPE_FROM_INTERFACE (iface),
......@@ -149,6 +151,8 @@ g_dbus_object_manager_default_init (GDBusObjectManagerIface *iface)
* Gets the object path that @manager is for.
*
* Returns: A string owned by @manager. Do not free.
*
* Since: 2.30
*/
const gchar *
g_dbus_object_manager_get_object_path (GDBusObjectManager *manager)
......@@ -167,6 +171,8 @@ g_dbus_object_manager_get_object_path (GDBusObjectManager *manager)
* #GDBusObject objects. The returned list should be freed with
* g_list_free() after each element has been freed with
* g_object_unref().
*
* Since: 2.30
*/
GList *
g_dbus_object_manager_get_objects (GDBusObjectManager *manager)
......@@ -183,6 +189,8 @@ g_dbus_object_manager_get_objects (GDBusObjectManager *manager)
* Gets the #GDBusObjectProxy at @object_path, if any.
*
* Returns: A #GDBusObject or %NULL. Free with g_object_unref().
*
* Since: 2.30
*/
GDBusObject *
g_dbus_object_manager_get_object (GDBusObjectManager *manager,
......@@ -203,6 +211,8 @@ g_dbus_object_manager_get_object (GDBusObjectManager *manager,
* any.
*
* Returns: A #GDBusInterface instance or %NULL. Free with g_object_unref().
*
* Since: 2.30
*/
GDBusInterface *
g_dbus_object_manager_get_interface (GDBusObjectManager *manager,
......
......@@ -47,6 +47,8 @@ typedef struct _GDBusObjectManagerIface GDBusObjectManagerIface;
* @interface_removed: Signal handler for the #GDBusObjectManager::interface-removed signal.
*
* Base type for D-Bus object managers.
*
* Since: 2.30
*/
struct _GDBusObjectManagerIface
{
......
......@@ -314,6 +314,8 @@ g_dbus_object_manager_client_class_init (GDBusObjectManagerClientClass *klass)
* GDBusObjectManagerClient:connection:
*
* The #GDBusConnection to use.
*
* Since: 2.30
*/
g_object_class_install_property (gobject_class,
PROP_CONNECTION,
......@@ -333,6 +335,8 @@ g_dbus_object_manager_client_class_init (GDBusObjectManagerClientClass *klass)
* #GDBusObjectManagerClient:connection must be %NULL and will be set to the
* #GDBusConnection obtained by calling g_bus_get() with the value
* of this property.
*
* Since: 2.30
*/
g_object_class_install_property (gobject_class,
PROP_BUS_TYPE,
......@@ -351,6 +355,8 @@ g_dbus_object_manager_client_class_init (GDBusObjectManagerClientClass *klass)
* GDBusObjectManagerClient:flags:
*
* Flags from the #GDBusObjectManagerClientFlags enumeration.
*
* Since: 2.30
*/
g_object_class_install_property (gobject_class,
PROP_FLAGS,
......@@ -370,6 +376,8 @@ g_dbus_object_manager_client_class_init (GDBusObjectManagerClientClass *klass)
* GDBusObjectManagerClient:object-path:
*
* The object path the manager is for.
*
* Since: 2.30
*/
g_object_class_install_property (gobject_class,
PROP_OBJECT_PATH,
......@@ -386,6 +394,8 @@ g_dbus_object_manager_client_class_init (GDBusObjectManagerClientClass *klass)
* GDBusObjectManagerClient:name:
*
* The well-known name or unique name that the manager is for.
*
* Since: 2.30
*/
g_object_class_install_property (gobject_class,
PROP_NAME,
......@@ -404,6 +414,8 @@ g_dbus_object_manager_client_class_init (GDBusObjectManagerClientClass *klass)
* The unique name that owns #GDBusObjectManagerClient:name or %NULL if
* no-one is currently owning the name. Connect to the
* #GObject::notify signal to track changes to this property.
*
* Since: 2.30
*/
g_object_class_install_property (gobject_class,
PROP_NAME_OWNER,
......@@ -419,6 +431,8 @@ g_dbus_object_manager_client_class_init (GDBusObjectManagerClientClass *klass)
*
* The #GDBusProxyTypeFunc to use when determining what #GType to
* use for interface proxies or %NULL.
*
* Since: 2.30
*/
g_object_class_install_property (gobject_class,
PROP_GET_PROXY_TYPE_FUNC,
......@@ -434,6 +448,8 @@ g_dbus_object_manager_client_class_init (GDBusObjectManagerClientClass *klass)
* GDBusObjectManagerClient:get-proxy-type-user-data:
*
* The #gpointer user_data to pass to #GDBusObjectManagerClient:get-proxy-type-func.
*
* Since: 2.30
*/
g_object_class_install_property (gobject_class,
PROP_GET_PROXY_TYPE_USER_DATA,
......@@ -462,6 +478,8 @@ g_dbus_object_manager_client_class_init (GDBusObjectManagerClientClass *klass)
* This signal is emitted in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* that @manager was constructed in.
*
* Since: 2.30
*/
signals[INTERFACE_PROXY_SIGNAL_SIGNAL] =
g_signal_new ("interface-proxy-signal",
......@@ -498,6 +516,8 @@ g_dbus_object_manager_client_class_init (GDBusObjectManagerClientClass *klass)
* This signal is emitted in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* that @manager was constructed in.
*
* Since: 2.30
*/
signals[INTERFACE_PROXY_PROPERTIES_CHANGED_SIGNAL] =
g_signal_new ("interface-proxy-properties-changed",
......@@ -550,6 +570,8 @@ g_dbus_object_manager_client_init (GDBusObjectManagerClient *manager)
*
* Returns: A #GDBusObjectManagerClient object or %NULL if @error is
* set. Free with g_object_unref().
*
* Since: 2.30
*/
GDBusObjectManager *
g_dbus_object_manager_client_new_sync (GDBusConnection *connection,
......@@ -605,6 +627,8 @@ g_dbus_object_manager_client_new_sync (GDBusConnection *connection
* of the thread you are calling this method from. You can
* then call g_dbus_object_manager_client_new_finish() to get the result. See
* g_dbus_object_manager_client_new_sync() for the synchronous version.
*
* Since: 2.30
*/
void
g_dbus_object_manager_client_new (GDBusConnection *connection,
......@@ -645,6 +669,8 @@ g_dbus_object_manager_client_new (GDBusConnection *connection,
*
* Returns: A #GDBusObjectManagerClient object or %NULL if @error is
* set. Free with g_object_unref().
*
* Since: 2.30
*/
GDBusObjectManager *
g_dbus_object_manager_client_new_finish (GAsyncResult *res,
......@@ -689,6 +715,8 @@ g_dbus_object_manager_client_new_finish (GAsyncResult *res,
*
* Returns: A #GDBusObjectManagerClient object or %NULL if @error is
* set. Free with g_object_unref().
*
* Since: 2.30
*/
GDBusObjectManager *
g_dbus_object_manager_client_new_for_bus_sync (GBusType bus_type,
......@@ -744,6 +772,8 @@ g_dbus_object_manager_client_new_for_bus_sync (GBusType bu
* of the thread you are calling this method from. You can
* then call g_dbus_object_manager_client_new_for_bus_finish() to get the result. See
* g_dbus_object_manager_client_new_for_bus_sync() for the synchronous version.
*
* Since: 2.30
*/
void
g_dbus_object_manager_client_new_for_bus (GBusType bus_type,
......@@ -783,6 +813,8 @@ g_dbus_object_manager_client_new_for_bus (GBusType bus_typ
*
* Returns: A #GDBusObjectManagerClient object or %NULL if @error is
* set. Free with g_object_unref().
*
* Since: 2.30
*/
GDBusObjectManager *
g_dbus_object_manager_client_new_for_bus_finish (GAsyncResult *res,
......@@ -815,6 +847,8 @@ g_dbus_object_manager_client_new_for_bus_finish (GAsyncResult *res,
*
* Returns: A #GDBusConnection object. Do not free, the object belongs
* to @manager.
*
* Since: 2.30
*/
GDBusConnection *
g_dbus_object_manager_client_get_connection (GDBusObjectManagerClient *manager)
......@@ -831,6 +865,8 @@ g_dbus_object_manager_client_get_connection (GDBusObjectManagerClient *manager)
*
* Returns: A unique or well-known name. Do not free, the string
* belongs to @manager.
*
* Since: 2.30
*/
const gchar *
g_dbus_object_manager_client_get_name (GDBusObjectManagerClient *manager)
......@@ -847,6 +883,8 @@ g_dbus_object_manager_client_get_name (GDBusObjectManagerClient *manager)
*
* Returns: Zero of more flags from the #GDBusObjectManagerClientFlags
* enumeration.
*
* Since: 2.30
*/
GDBusObjectManagerClientFlags
g_dbus_object_manager_client_get_flags (GDBusObjectManagerClient *manager)
......@@ -866,6 +904,8 @@ g_dbus_object_manager_client_get_flags (GDBusObjectManagerClient *manager)
*
* Returns: The name owner or %NULL if no name owner exists. Free with
* g_free().
*
* Since: 2.30
*/
gchar *
g_dbus_object_manager_client_get_name_owner (GDBusObjectManagerClient *manager)
......
......@@ -42,6 +42,8 @@ typedef struct _GDBusObjectManagerClientPrivate GDBusObjectManagerClientPrivate;
*
* The #GDBusObjectManagerClient structure contains private data and should
* only be accessed using the provided API.
*
* Since: 2.30
*/
struct _GDBusObjectManagerClient
{
......@@ -57,6 +59,8 @@ struct _GDBusObjectManagerClient
* @interface_proxy_properties_changed: Signal class handler for the #GDBusObjectManagerClient::interface-proxy-properties-changed signal.
*
* Class structure for #GDBusObjectManagerClient.
*
* Since: 2.30
*/
struct _GDBusObjectManagerClientClass
{
......
......@@ -176,6 +176,8 @@ g_dbus_object_manager_server_class_init (GDBusObjectManagerServerClass *klass)
* GDBusObjectManagerServer:connection:
*
* The #GDBusConnection to export objects on.
*
* Since: 2.30
*/
g_object_class_install_property (gobject_class,
PROP_CONNECTION,
......@@ -192,6 +194,8 @@ g_dbus_object_manager_server_class_init (GDBusObjectManagerServerClass *klass)
* GDBusObjectManagerServer:object-path:
*
* The object path to register the manager object at.
*
* Since: 2.30
*/
g_object_class_install_property (gobject_class,
PROP_OBJECT_PATH,
......@@ -230,6 +234,8 @@ g_dbus_object_manager_server_init (GDBusObjectManagerServer *manager)
* e.g. start()/stop() semantics.
*
* Returns: A #GDBusObjectManagerServer object. Free with g_object_unref().
*
* Since: 2.30
*/
GDBusObjectManagerServer *
g_dbus_object_manager_server_new (GDBusConnection *connection,
......@@ -251,6 +257,8 @@ g_dbus_object_manager_server_new (GDBusConnection *connection,
*
* Returns: A #GDBusConnection object. Do not free, the object belongs
* to @manager.
*
* Since: 2.30
*/
GDBusConnection *
g_dbus_object_manager_server_get_connection (GDBusObjectManagerServer *manager)
......@@ -392,6 +400,8 @@ registration_data_free (RegistrationData *data)
*
* Note that @manager will take a reference on @object for as long as
* it is exported.
*
* Since: 2.30
*/
void
g_dbus_object_manager_server_export (GDBusObjectManagerServer *manager,
......@@ -467,6 +477,8 @@ g_dbus_object_manager_server_export (GDBusObjectManagerServer *manager,
* @object<!-- -->'s object path if an object with the given path
* already exists. As such, the #GDBusObjectProxy:object-path property
* of @object may be modified.
*
* Since: 2.30
*/
void
g_dbus_object_manager_server_export_and_uniquify (GDBusObjectManagerServer *manager,
......@@ -518,6 +530,8 @@ g_dbus_object_manager_server_export_and_uniquify (GDBusObjectManagerServer *man
*
* Note that @object_path must be in the hierarchy rooted by the
* object path for @manager.
*
* Since: 2.30
*/
void
g_dbus_object_manager_server_unexport (GDBusObjectManagerServer *manager,
......
......@@ -39,9 +39,11 @@ typedef struct _GDBusObjectManagerServerPrivate GDBusObjectManagerServerPrivate;
/**
* GDBusObjectManagerServer:
*
*
* The #GDBusObjectManagerServer structure contains private data and should
* only be accessed using the provided API.
*
* Since: 2.30
*/
struct _GDBusObjectManagerServer
{
......@@ -55,6 +57,8 @@ struct _GDBusObjectManagerServer
* @parent_class: The parent class.
*
* Class structure for #GDBusObjectManagerServer.
*
* Since: 2.30
*/
struct _GDBusObjectManagerServerClass
{
......
......@@ -40,6 +40,8 @@
* with one or more D-Bus interfaces. You cannot instantiate a
* #GDBusObjectProxy yourself - you need to use a
* #GDBusObjectManagerClient to get one.
*
* Since: 2.30
*/
struct _GDBusObjectProxyPrivate
......@@ -123,6 +125,8 @@ g_dbus_object_proxy_class_init (GDBusObjectProxyClass *klass)
* GDBusObjectProxy:object-path:
*
* The object path of the proxy.
*
* Since: 2.30
*/
g_object_class_install_property (gobject_class,
PROP_OBJECT_PATH,
......@@ -137,6 +141,8 @@ g_dbus_object_proxy_class_init (GDBusObjectProxyClass *klass)
* GDBusObjectProxy:connection:
*
* The connection of the proxy.
*
* Since: 2.30
*/
g_object_class_install_property (gobject_class,
PROP_CONNECTION,
......@@ -176,6 +182,8 @@ g_dbus_object_proxy_get_object_path (GDBusObject *object)
* Gets the connection that @proxy is for.
*
* Returns: A #GDBusConnection. Do not free, the object is owned by @proxy.
*
* Since: 2.30
*/
GDBusConnection *
g_dbus_object_proxy_get_connection (GDBusObjectProxy *proxy)
......
......@@ -42,6 +42,8 @@ typedef struct _GDBusObjectProxyPrivate GDBusObjectProxyPrivate;
*
* The #GDBusObjectProxy structure contains private data and should
* only be accessed using the provided API.
*
* Since: 2.30
*/
struct _GDBusObjectProxy
{
......@@ -55,6 +57,8 @@ struct _GDBusObjectProxy
* @parent_class: The parent class.
*
* Class structure for #GDBusObjectProxy.
*
* Since: 2.30
*/
struct _GDBusObjectProxyClass
{
......
......@@ -147,6 +147,8 @@ g_dbus_object_stub_class_init (GDBusObjectStubClass *klass)
* GDBusObjectStub:object-path:
*
* The object path where the object is exported.
*
* Since: 2.30
*/
g_object_class_install_property (gobject_class,
PROP_OBJECT_PATH,
......@@ -175,6 +177,8 @@ g_dbus_object_stub_class_init (GDBusObjectStubClass *klass)
* The default class handler just returns %TRUE.
*
* Returns: %TRUE if the call is authorized, %FALSE otherwise.
*
* Since: 2.30
*/
signals[AUTHORIZE_METHOD_SIGNAL] =
g_signal_new ("authorize-method",
......@@ -209,6 +213,8 @@ g_dbus_object_stub_init (GDBusObjectStub *object)
* Creates a new #GDBusObjectStub.
*
* Returns: A #GDBusObjectStub. Free with g_object_unref().
*
* Since: 2.30
*/
GDBusObjectStub *
g_dbus_object_stub_new (const gchar *object_path)
......@@ -225,6 +231,8 @@ g_dbus_object_stub_new (const gchar *object_path)
* @object_path: A valid D-Bus object path.
*
* Sets the object path for @object.
*
* Since: 2.30
*/
void
g_dbus_object_stub_set_object_path (GDBusObjectStub *object,
......@@ -260,6 +268,8 @@ g_dbus_object_stub_get_object_path (GDBusObject *_object)
*
* Note that @object takes its own reference on @interface and holds
* it until removed.
*
* Since: 2.30
*/
void
g_dbus_object_stub_add_interface (GDBusObjectStub *object,
......@@ -288,6 +298,8 @@ g_dbus_object_stub_add_interface (GDBusObjectStub *object,
* @interface: A #GDBusInterfaceStub.
*
* Removes @interface from @object.
*
* Since: 2.30
*/
void
g_dbus_object_stub_remove_interface (GDBusObjectStub *object,
......@@ -340,6 +352,8 @@ g_dbus_object_stub_remove_interface (GDBusObjectStub *object,
*
* If no D-Bus interface of the given interface exists, this function
* does nothing.
*
* Since: 2.30
*/
void
g_dbus_object_stub_remove_interface_by_name (GDBusObjectStub *object,
......@@ -405,6 +419,8 @@ g_dbus_object_stub_get_interfaces (GDBusObject *_object)
* This method simply calls g_dbus_interface_stub_flush() on all
* interfaces stubs belonging to @object. See that method for when
* flushing is useful.
*
* Since: 2.30
*/
void
g_dbus_object_stub_flush (GDBusObjectStub *object)
......
......@@ -39,9 +39,11 @@ typedef struct _GDBusObjectStubPrivate GDBusObjectStubPrivate;
/**
* GDBusObjectStub:
*
*
* The #GDBusObjectStub structure contains private data and should only be
* accessed using the provided API.
*
* Since: 2.30
*/
struct _GDBusObjectStub
{
......@@ -56,6 +58,8 @@ struct _GDBusObjectStub
* @authorize_method: Signal class handler for the #GDBusObjectStub::authorize-method signal.
*
* Class structure for #GDBusObjectStub.
*
* Since: 2.30
*/
struct _GDBusObjectStubClass
{
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment