diff options
author | Vincent Untz <vuntz@gnome.org> | 2007-07-10 09:39:10 +0000 |
---|---|---|
committer | Vincent Untz <vuntz@src.gnome.org> | 2007-07-10 09:39:10 +0000 |
commit | a5a5167182f73403bb110e84559ac24262896d1a (patch) | |
tree | fa3c238d1f0088240fea36284ddaadb325ec3f47 /libwnck | |
parent | ee1f768fd5a0d810ff53ca51d1608fa7e6ac64f2 (diff) | |
download | libwnck-a5a5167182f73403bb110e84559ac24262896d1a.tar.gz |
reorganize a bit some part of the API documentation
2007-07-10 Vincent Untz <vuntz@gnome.org>
* libwnck/doc/libwnck-docs.sgml:
* libwnck/doc/libwnck-sections.txt:
* libwnck/doc/tmpl/misc.sgml:
* libwnck/doc/tmpl/resource.sgml:
* libwnck/libwnck/util.c: reorganize a bit some part of the API
documentation
svn path=/trunk/; revision=1407
Diffstat (limited to 'libwnck')
-rw-r--r-- | libwnck/util.c | 26 |
1 files changed, 19 insertions, 7 deletions
diff --git a/libwnck/util.c b/libwnck/util.c index e0e2b63..a335ec2 100644 --- a/libwnck/util.c +++ b/libwnck/util.c @@ -34,14 +34,23 @@ #endif /** - * SECTION:util - * @short_description: reading resource usage of X clients, and other - * additional features. + * SECTION:resource + * @short_description: reading resource usage of X clients. * @see_also: wnck_window_get_xid(), wnck_application_get_xid(), wnck_window_get_pid(), wnck_application_get_pid() * @stability: Unstable * + * libwnck provides an easy-to-use interface to the XRes X server extension to + * read resource usage of X clients, which can be defined either by the X + * window ID of one of their windows or by the process ID of their process. + */ + +/** + * SECTION:misc + * @short_description: other additional features. + * @stability: Unstable + * * These functions are utility functions providing some additional features to - * libwcnk users, like functions to read resource usage of X clients. + * libwcnk users. */ /** @@ -617,9 +626,12 @@ static WnckClientType client_type = 0; * wnck_set_client_type: * @ewmh_sourceindication_client_type: a role for the client. * - * Sets the role of the libwnck user. For applications providing some window - * management features, like pagers or tasklists, it is important to set the - * role to %WNCK_CLIENT_TYPE_PAGER for libwnck to properly work. + * Sets the role of the libwnck user. + * + * The default role is %WNCK_CLIENT_TYPE_APPLICATION. Therefore, for + * applications providing some window management features, like pagers or + * tasklists, it is important to set the role to %WNCK_CLIENT_TYPE_PAGER for + * libwnck to properly work. * * Since: 2.14 */ |