GDBus: Add some gobject-introspection annotations for new code

Signed-off-by: David Zeuthen <davidz@redhat.com>
This commit is contained in:
David Zeuthen 2011-04-16 14:42:21 -04:00
parent 3cef28a2f0
commit ea742e88e3
6 changed files with 30 additions and 23 deletions

View File

@ -294,7 +294,7 @@ g_dbus_interface_skeleton_get_info (GDBusInterfaceSkeleton *interface_)
} }
/** /**
* g_dbus_interface_skeleton_get_vtable: * g_dbus_interface_skeleton_get_vtable: (skip)
* @interface_: A #GDBusInterfaceSkeleton. * @interface_: A #GDBusInterfaceSkeleton.
* *
* Gets the interface vtable for the D-Bus interface implemented by * Gets the interface vtable for the D-Bus interface implemented by

View File

@ -133,8 +133,8 @@ g_dbus_object_get_interfaces (GDBusObject *object)
* Gets the D-Bus interface with name @interface_name associated with * Gets the D-Bus interface with name @interface_name associated with
* @object, if any. * @object, if any.
* *
* Returns: %NULL if not found, otherwise a #GDBusInterface that must * Returns: (transfer full): %NULL if not found, otherwise a
* be freed with g_object_unref(). * #GDBusInterface that must be freed with g_object_unref().
* *
* Since: 2.30 * Since: 2.30
*/ */
@ -160,9 +160,9 @@ g_dbus_object_get_interface (GDBusObject *object,
* <note><para>This function is intended to only be used in type * <note><para>This function is intended to only be used in type
* implementations.</para></note> * implementations.</para></note>
* *
* Returns: A #GDBusInterface implementing @type or %NULL if * Returns: (transfer none): A #GDBusInterface implementing @type or
* not found. Do not free the returned object, it is owned by * %NULL if not found. Do not free the returned object, it is owned
* @object. * by @object.
* *
* Since: 2.30 * Since: 2.30
*/ */
@ -188,8 +188,8 @@ g_dbus_object_peek_with_typecheck (GDBusObject *object,
* <note><para>This function is intended to only be used in type * <note><para>This function is intended to only be used in type
* implementations.</para></note> * implementations.</para></note>
* *
* Returns: A #GDBusInterface implementing @type or %NULL if * Returns: (transfer full): A #GDBusInterface implementing @type or
* not found. Free with g_object_unref(). * %NULL if not found. Free with g_object_unref().
* *
* Since: 2.30 * Since: 2.30
*/ */

View File

@ -188,7 +188,8 @@ g_dbus_object_manager_get_objects (GDBusObjectManager *manager)
* *
* Gets the #GDBusObjectProxy at @object_path, if any. * Gets the #GDBusObjectProxy at @object_path, if any.
* *
* Returns: A #GDBusObject or %NULL. Free with g_object_unref(). * Returns: (transfer full): A #GDBusObject or %NULL. Free with
* g_object_unref().
* *
* Since: 2.30 * Since: 2.30
*/ */
@ -210,7 +211,8 @@ g_dbus_object_manager_get_object (GDBusObjectManager *manager,
* Gets the interface proxy for @interface_name at @object_path, if * Gets the interface proxy for @interface_name at @object_path, if
* any. * any.
* *
* Returns: A #GDBusInterface instance or %NULL. Free with g_object_unref(). * Returns: (transfer full): A #GDBusInterface instance or %NULL. Free
* with g_object_unref().
* *
* Since: 2.30 * Since: 2.30
*/ */

View File

@ -568,8 +568,9 @@ g_dbus_object_manager_client_init (GDBusObjectManagerClient *manager)
* blocked until a reply is received. See g_dbus_object_manager_client_new() * blocked until a reply is received. See g_dbus_object_manager_client_new()
* for the asynchronous version. * for the asynchronous version.
* *
* Returns: A #GDBusObjectManagerClient object or %NULL if @error is * Returns: (transfer full) (type GDBusObjectManagerClient): A
* set. Free with g_object_unref(). * #GDBusObjectManagerClient object or %NULL if @error is set. Free
* with g_object_unref().
* *
* Since: 2.30 * Since: 2.30
*/ */
@ -667,8 +668,9 @@ g_dbus_object_manager_client_new (GDBusConnection *connection,
* *
* Finishes an operation started with g_dbus_object_manager_client_new(). * Finishes an operation started with g_dbus_object_manager_client_new().
* *
* Returns: A #GDBusObjectManagerClient object or %NULL if @error is * Returns: (transfer full) (type GDBusObjectManagerClient): A
* set. Free with g_object_unref(). * #GDBusObjectManagerClient object or %NULL if @error is set. Free
* with g_object_unref().
* *
* Since: 2.30 * Since: 2.30
*/ */
@ -713,8 +715,9 @@ g_dbus_object_manager_client_new_finish (GAsyncResult *res,
* blocked until a reply is received. See g_dbus_object_manager_client_new_for_bus() * blocked until a reply is received. See g_dbus_object_manager_client_new_for_bus()
* for the asynchronous version. * for the asynchronous version.
* *
* Returns: A #GDBusObjectManagerClient object or %NULL if @error is * Returns: (transfer full) (type GDBusObjectManagerClient): A
* set. Free with g_object_unref(). * #GDBusObjectManagerClient object or %NULL if @error is set. Free
* with g_object_unref().
* *
* Since: 2.30 * Since: 2.30
*/ */
@ -811,8 +814,9 @@ g_dbus_object_manager_client_new_for_bus (GBusType bus_typ
* *
* Finishes an operation started with g_dbus_object_manager_client_new_for_bus(). * Finishes an operation started with g_dbus_object_manager_client_new_for_bus().
* *
* Returns: A #GDBusObjectManagerClient object or %NULL if @error is * Returns: (transfer full) (type GDBusObjectManagerClient): A
* set. Free with g_object_unref(). * #GDBusObjectManagerClient object or %NULL if @error is set. Free
* with g_object_unref().
* *
* Since: 2.30 * Since: 2.30
*/ */
@ -845,8 +849,8 @@ g_dbus_object_manager_client_new_for_bus_finish (GAsyncResult *res,
* *
* Gets the #GDBusConnection used by @manager. * Gets the #GDBusConnection used by @manager.
* *
* Returns: A #GDBusConnection object. Do not free, the object belongs * Returns: (transfer none): A #GDBusConnection object. Do not free,
* to @manager. * the object belongs to @manager.
* *
* Since: 2.30 * Since: 2.30
*/ */

View File

@ -255,8 +255,8 @@ g_dbus_object_manager_server_new (GDBusConnection *connection,
* *
* Gets the #GDBusConnection used by @manager. * Gets the #GDBusConnection used by @manager.
* *
* Returns: A #GDBusConnection object. Do not free, the object belongs * Returns: (transfer none): A #GDBusConnection object. Do not free,
* to @manager. * the object belongs to @manager.
* *
* Since: 2.30 * Since: 2.30
*/ */

View File

@ -181,7 +181,8 @@ g_dbus_object_proxy_get_object_path (GDBusObject *object)
* *
* Gets the connection that @proxy is for. * Gets the connection that @proxy is for.
* *
* Returns: A #GDBusConnection. Do not free, the object is owned by @proxy. * Returns: (transfer none): A #GDBusConnection. Do not free, the
* object is owned by @proxy.
* *
* Since: 2.30 * Since: 2.30
*/ */