diff options
| author | Vincent Untz <vuntz@gnome.org> | 2007-06-09 00:43:09 +0000 |
|---|---|---|
| committer | Vincent Untz <vuntz@src.gnome.org> | 2007-06-09 00:43:09 +0000 |
| commit | 98f265758b826b2c8bc12c98fdb1f48042de8658 (patch) | |
| tree | c90295f310faf8badc71cb193913841af6cf09c3 /libwnck/class-group.c | |
| parent | bd6155e3cafe8e889a9c315f98495dee5da5d01e (diff) | |
| download | libwnck-98f265758b826b2c8bc12c98fdb1f48042de8658.tar.gz | |
add more API documentation
2007-06-09 Vincent Untz <vuntz@gnome.org>
* doc/libwnck-docs.sgml:
* libwnck/application.c:
* libwnck/class-group.c:
* libwnck/pager.c:
* libwnck/screen.c:
* libwnck/window.c:
* libwnck/workspace.c: add more API documentation
svn path=/trunk/; revision=1284
Diffstat (limited to 'libwnck/class-group.c')
| -rw-r--r-- | libwnck/class-group.c | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/libwnck/class-group.c b/libwnck/class-group.c index 755a281..b790fea 100644 --- a/libwnck/class-group.c +++ b/libwnck/class-group.c @@ -43,7 +43,7 @@ * url="http://tronche.com/gui/x/icccm/">ICCCM</ulink>. * * The #WnckClassGroup objects are always owned by libwnck and must not be - * unreferenced. + * referenced or unreferenced. */ /* FIXME: the ulink should be a link to * http://tronche.com/gui/x/icccm/sec-4.html#s-4.1.2.5 but gtk-doc fails @@ -201,8 +201,9 @@ wnck_class_group_finalize (GObject *object) * * Returns an existing class group based on its resource class name. * - * Return value: an existing #WnckClassGroup, or NULL if there is no group with - * the specified @res_class. + * Return value: an existing #WnckClassGroup, or %NULL if there is no group + * with the specified @res_class. The returned #WnckClassGroup is owned by + * libwnck and must not be referenced or unreferenced. **/ WnckClassGroup * wnck_class_group_get (const char *res_class) @@ -555,7 +556,7 @@ _wnck_class_group_remove_window (WnckClassGroup *class_group, * * Returns the list of #WnckWindow that are grouped in @class_group. * - * Return value: the list of #WnckWindow grouped in @class_group, or NULL if + * Return value: the list of #WnckWindow grouped in @class_group, or %NULL if * the group contains no window. The list should not be modified nor freed, as * it is owned by @class_group. **/ |