From f4cff2b923dd4df811327c9f199614dbfcbfe436 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Sun, 1 May 2011 23:02:53 -0400 Subject: [PATCH] Some documentation additions --- docs/reference/gio/gio-sections.txt | 4 ++++ gio/gdbusobjectproxy.c | 16 ++++++++++++++-- gio/gdesktopappinfo.c | 18 ++++++++++++------ 3 files changed, 30 insertions(+), 8 deletions(-) diff --git a/docs/reference/gio/gio-sections.txt b/docs/reference/gio/gio-sections.txt index 599568a..751cd1c 100644 --- a/docs/reference/gio/gio-sections.txt +++ b/docs/reference/gio/gio-sections.txt @@ -1399,6 +1399,8 @@ g_desktop_app_info_new_from_keyfile g_desktop_app_info_new g_desktop_app_info_get_filename g_desktop_app_info_get_is_hidden +g_desktop_app_info_get_generic_name +g_desktop_app_info_get_categories g_desktop_app_info_set_desktop_env GDesktopAppLaunchCallback g_desktop_app_info_launch_uris_as_manager @@ -1412,6 +1414,8 @@ G_IS_DESKTOP_APP_INFO_CLASS G_DESKTOP_APP_INFO_GET_CLASS g_desktop_app_info_get_type +g_desktop_app_info_lookup_get_default_for_uri_scheme +g_desktop_app_info_lookup_get_type
diff --git a/gio/gdbusobjectproxy.c b/gio/gdbusobjectproxy.c index 46f249b..2042b07 100644 --- a/gio/gdbusobjectproxy.c +++ b/gio/gdbusobjectproxy.c @@ -189,7 +189,7 @@ g_dbus_object_proxy_get_object_path (GDBusObject *object) /** * g_dbus_object_proxy_get_connection: - * @proxy: A #GDBusObjectProxy. + * @proxy: a #GDBusObjectProxy * * Gets the connection that @proxy is for. * @@ -242,9 +242,21 @@ g_dbus_object_proxy_get_interfaces (GDBusObject *object) /* ---------------------------------------------------------------------------------------------------- */ +/** + * g_dbus_object_proxy_new: + * @connection: a #GDBusConnection + * @object_path: the object path + * + * Creates a new #GDBusObjectProxy for the given connection and + * object path. + * + * Returns: a new #GDBusObjectProxy + * + * Since: 2.30 + */ GDBusObjectProxy * g_dbus_object_proxy_new (GDBusConnection *connection, - const gchar *object_path) + const gchar *object_path) { g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL); g_return_val_if_fail (g_variant_is_object_path (object_path), NULL); diff --git a/gio/gdesktopappinfo.c b/gio/gdesktopappinfo.c index f72de34..11b5ed6 100644 --- a/gio/gdesktopappinfo.c +++ b/gio/gdesktopappinfo.c @@ -1,5 +1,5 @@ /* GIO - GLib Input, Output and Streaming Library - * + * * Copyright (C) 2006-2007 Red Hat, Inc. * Copyright © 2007 Ryan Lortie * @@ -648,11 +648,13 @@ g_desktop_app_info_get_icon (GAppInfo *appinfo) * g_desktop_app_info_get_categories: * @info: a #GDesktopAppInfo * - * Returns: The unparsed Categories key from the file; i.e. no attempt - * is made to split it by ';' or validate it. + * Gets the categories from the desktop file. + * + * Returns: The unparsed Categories key from the desktop file; + * i.e. no attempt is made to split it by ';' or validate it. */ const char * -g_desktop_app_info_get_categories (GDesktopAppInfo *info) +g_desktop_app_info_get_categories (GDesktopAppInfo *info) { return info->categories; } @@ -661,10 +663,12 @@ g_desktop_app_info_get_categories (GDesktopAppInfo *info) * g_desktop_app_info_get_generic_name: * @info: a #GDesktopAppInfo * + * Gets the generic name from the destkop file. + * * Returns: The value of the GenericName key */ const char * -g_desktop_app_info_get_generic_name (GDesktopAppInfo *info) +g_desktop_app_info_get_generic_name (GDesktopAppInfo *info) { return info->generic_name; } @@ -1313,7 +1317,7 @@ g_desktop_app_info_launch (GAppInfo *appinfo, * @user_setup_data: (closure user_setup): User data for @user_setup * @pid_callback: (scope call): Callback for child processes * @pid_callback_data: (closure pid_callback): User data for @callback - * @error: a #GError + * @error: return location for a #GError, or %NULL * * This function performs the equivalent of g_app_info_launch_uris(), * but is intended primarily for operating system components that @@ -1329,6 +1333,8 @@ g_desktop_app_info_launch (GAppInfo *appinfo, * @setup, as well as the process identifier of each child process via * @pid_callback. See g_spawn_async() for more information about the * semantics of the @setup function. + * + * Returns: %TRUE on successful launch, %FALSE otherwise. */ gboolean g_desktop_app_info_launch_uris_as_manager (GDesktopAppInfo *appinfo, -- 2.7.4