luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-12-25 23:16:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: Make argument names in GAppInfo consistent

Browse Source 
This fixes a mismatch between some of the gtk-doc comments and reality.

Signed-off-by: Philip Withnall <withnall@endlessm.com>

https://bugzilla.gnome.org/show_bug.cgi?id=790015
This commit is contained in:
Philip Withnall 2017-11-07 13:35:51 +00:00
parent a12fbd227f
commit 249d74fcf6
2 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
gio/gappinfo.c
View File

@ -536,11 +536,11 @@ g_app_info_get_icon (GAppInfo *appinfo)
* g_app_info_launch: * g_app_info_launch:
* @appinfo: a #GAppInfo * @appinfo: a #GAppInfo
* @files: (nullable) (element-type GFile): a #GList of #GFile objects * @files: (nullable) (element-type GFile): a #GList of #GFile objects
* @launch_context: (nullable): a #GAppLaunchContext or %NULL * @context: (nullable): a #GAppLaunchContext or %NULL
* @error: a #GError * @error: a #GError
* *
* Launches the application. Passes @files to the launched application * Launches the application. Passes @files to the launched application
* as arguments, using the optional @launch_context to get information * as arguments, using the optional @context to get information
* about the details of the launcher (like what screen it is on). * about the details of the launcher (like what screen it is on).
* On error, @error will be set accordingly. * On error, @error will be set accordingly.
* *
@ -565,7 +565,7 @@ g_app_info_get_icon (GAppInfo *appinfo)
* process. This can be used to ignore `GIO_LAUNCHED_DESKTOP_FILE`, * process. This can be used to ignore `GIO_LAUNCHED_DESKTOP_FILE`,
* should it be inherited by further processes. The `DISPLAY` and * should it be inherited by further processes. The `DISPLAY` and
* `DESKTOP_STARTUP_ID` environment variables are also set, based * `DESKTOP_STARTUP_ID` environment variables are also set, based
* on information provided in @launch_context. * on information provided in @context.
* *
* Returns: %TRUE on successful launch, %FALSE otherwise. * Returns: %TRUE on successful launch, %FALSE otherwise.
**/ **/
@ -631,11 +631,11 @@ g_app_info_supports_files (GAppInfo *appinfo)
* g_app_info_launch_uris: * g_app_info_launch_uris:
* @appinfo: a #GAppInfo * @appinfo: a #GAppInfo
* @uris: (nullable) (element-type utf8): a #GList containing URIs to launch. * @uris: (nullable) (element-type utf8): a #GList containing URIs to launch.
* @launch_context: (nullable): a #GAppLaunchContext or %NULL * @context: (nullable): a #GAppLaunchContext or %NULL
* @error: a #GError * @error: a #GError
* *
* Launches the application. This passes the @uris to the launched application * Launches the application. This passes the @uris to the launched application
* as arguments, using the optional @launch_context to get information * as arguments, using the optional @context to get information
* about the details of the launcher (like what screen it is on). * about the details of the launcher (like what screen it is on).
* On error, @error will be set accordingly. * On error, @error will be set accordingly.
* *
@ -727,7 +727,7 @@ launch_default_for_uri (const char *uri,
/** /**
* g_app_info_launch_default_for_uri: * g_app_info_launch_default_for_uri:
* @uri: the uri to show * @uri: the uri to show
* @launch_context: (nullable): an optional #GAppLaunchContext * @context: (nullable): an optional #GAppLaunchContext
* @error: (nullable): return location for an error, or %NULL * @error: (nullable): return location for an error, or %NULL
* *
* Utility function that launches the default application * Utility function that launches the default application

12
gio/gappinfo.h
View File

@ -99,13 +99,13 @@ struct _GAppInfoIface
GIcon * (* get_icon) (GAppInfo *appinfo); GIcon * (* get_icon) (GAppInfo *appinfo);
gboolean (* launch) (GAppInfo *appinfo, gboolean (* launch) (GAppInfo *appinfo,
GList *files, GList *files,
GAppLaunchContext *launch_context, GAppLaunchContext *context,
GError **error); GError **error);
gboolean (* supports_uris) (GAppInfo *appinfo); gboolean (* supports_uris) (GAppInfo *appinfo);
gboolean (* supports_files) (GAppInfo *appinfo); gboolean (* supports_files) (GAppInfo *appinfo);
gboolean (* launch_uris) (GAppInfo *appinfo, gboolean (* launch_uris) (GAppInfo *appinfo,
GList *uris, GList *uris,
GAppLaunchContext *launch_context, GAppLaunchContext *context,
GError **error); GError **error);
gboolean (* should_show) (GAppInfo *appinfo); gboolean (* should_show) (GAppInfo *appinfo);
@ -162,7 +162,7 @@ GIcon * g_app_info_get_icon (GAppInfo *appin
GLIB_AVAILABLE_IN_ALL GLIB_AVAILABLE_IN_ALL
gboolean g_app_info_launch (GAppInfo *appinfo, gboolean g_app_info_launch (GAppInfo *appinfo,
GList *files, GList *files,
GAppLaunchContext *launch_context, GAppLaunchContext *context,
GError **error); GError **error);
GLIB_AVAILABLE_IN_ALL GLIB_AVAILABLE_IN_ALL
gboolean g_app_info_supports_uris (GAppInfo *appinfo); gboolean g_app_info_supports_uris (GAppInfo *appinfo);
@ -171,7 +171,7 @@ gboolean g_app_info_supports_files (GAppInfo *appin
GLIB_AVAILABLE_IN_ALL GLIB_AVAILABLE_IN_ALL
gboolean g_app_info_launch_uris (GAppInfo *appinfo, gboolean g_app_info_launch_uris (GAppInfo *appinfo,
GList *uris, GList *uris,
GAppLaunchContext *launch_context, GAppLaunchContext *context,
GError **error); GError **error);
GLIB_AVAILABLE_IN_ALL GLIB_AVAILABLE_IN_ALL
gboolean g_app_info_should_show (GAppInfo *appinfo); gboolean g_app_info_should_show (GAppInfo *appinfo);
@ -226,12 +226,12 @@ GAppInfo *g_app_info_get_default_for_uri_scheme (const char *uri_scheme);
GLIB_AVAILABLE_IN_ALL GLIB_AVAILABLE_IN_ALL
gboolean g_app_info_launch_default_for_uri (const char *uri, gboolean g_app_info_launch_default_for_uri (const char *uri,
GAppLaunchContext *launch_context, GAppLaunchContext *context,
GError **error); GError **error);
GLIB_AVAILABLE_IN_2_50 GLIB_AVAILABLE_IN_2_50
void g_app_info_launch_default_for_uri_async (const char *uri, void g_app_info_launch_default_for_uri_async (const char *uri,
GAppLaunchContext *launch_context, GAppLaunchContext *context,
GCancellable *cancellable, GCancellable *cancellable,
GAsyncReadyCallback callback, GAsyncReadyCallback callback,
gpointer user_data); gpointer user_data);