diff options
| author | Vincent Untz <vuntz@gnome.org> | 2007-06-09 04:04:59 +0000 |
|---|---|---|
| committer | Vincent Untz <vuntz@src.gnome.org> | 2007-06-09 04:04:59 +0000 |
| commit | f6431a91f9431d5e2d5e5b9f65803cf63dc07024 (patch) | |
| tree | 5bf85ac56e16c7e4343b4e3da2ec65b3fc2a4e7b /libwnck/application.c | |
| parent | 98f265758b826b2c8bc12c98fdb1f48042de8658 (diff) | |
| download | libwnck-f6431a91f9431d5e2d5e5b9f65803cf63dc07024.tar.gz | |
even more API documentation
2007-06-09 Vincent Untz <vuntz@gnome.org>
* doc/libwnck-docs.sgml:
* libwnck/application.[ch]:
* libwnck/class-group.[ch]:
* libwnck/pager.h:
* libwnck/screen.[ch]:
* libwnck/selector.h:
* libwnck/tasklist.h:
* libwnck/window.[ch]:
* libwnck/workspace.[ch]: even more API documentation
svn path=/trunk/; revision=1285
Diffstat (limited to 'libwnck/application.c')
| -rw-r--r-- | libwnck/application.c | 15 |
1 files changed, 7 insertions, 8 deletions
diff --git a/libwnck/application.c b/libwnck/application.c index 8ebe5d4..328fcb8 100644 --- a/libwnck/application.c +++ b/libwnck/application.c @@ -304,7 +304,7 @@ wnck_application_get_icon_name (WnckApplication *app) * * Returns the process ID of @app. * - * Return value: process ID of @app, or 0 if none is available. + * Return value: the process ID of @app, or 0 if none is available. **/ int wnck_application_get_pid (WnckApplication *app) @@ -383,9 +383,8 @@ find_icon_window (WnckApplication *app) * * Returns the icon to be used for @app. * - * Return value: the icon for @app. The caller should increase the - * reference count of the returned <classname>GdkPixbuf</classname> if it needs - * to keep the icon around. + * Return value: the icon for @app. The caller should reference the returned + * <classname>GdkPixbuf</classname> if it needs to keep the icon around. **/ GdkPixbuf* wnck_application_get_icon (WnckApplication *app) @@ -412,9 +411,9 @@ wnck_application_get_icon (WnckApplication *app) * * Returns the mini-icon to be used for @app. * - * Return value: the mini-icon for @app. The caller should increase the - * reference count of the returned <classname>GdkPixbuf</classname> if it needs - * to keep the mini-icon around. + * Return value: the mini-icon for @app. The caller should reference the + * returned <classname>GdkPixbuf</classname> if it needs to keep the mini-icon + * around. **/ GdkPixbuf* wnck_application_get_mini_icon (WnckApplication *app) @@ -442,7 +441,7 @@ wnck_application_get_mini_icon (WnckApplication *app) * Checks if we are using a default fallback icon because * none was set on the application. * - * Return value: %TRUE if icon is a fallback + * Return value: %TRUE if icon is a fallback, %FALSE otherwise. **/ gboolean wnck_application_get_icon_is_fallback (WnckApplication *app) |