summaryrefslogtreecommitdiff
path: root/doc/libwnck-docs.sgml
diff options
context:
space:
mode:
authorVincent Untz <vuntz@gnome.org>2007-06-08 22:00:41 +0000
committerVincent Untz <vuntz@src.gnome.org>2007-06-08 22:00:41 +0000
commitbd6155e3cafe8e889a9c315f98495dee5da5d01e (patch)
tree2fbeb84ed8553e4cb664354770cacfed7b44bc42 /doc/libwnck-docs.sgml
parent7b8bd21d7a909bfafe865105c02b5a46fb6dda59 (diff)
downloadlibwnck-bd6155e3cafe8e889a9c315f98495dee5da5d01e.tar.gz
add more API documentation
2007-06-08 Vincent Untz <vuntz@gnome.org> * doc/*: * libwnck/application.c: * libwnck/class-group.c: * libwnck/pager.[ch]: * libwnck/screen.c: * libwnck/selector.c: * libwnck/tasklist.[ch]: * libwnck/window.c: * libwnck/workspace.c: add more API documentation svn path=/trunk/; revision=1283
Diffstat (limited to 'doc/libwnck-docs.sgml')
-rw-r--r--doc/libwnck-docs.sgml6
1 files changed, 4 insertions, 2 deletions
diff --git a/doc/libwnck-docs.sgml b/doc/libwnck-docs.sgml
index 0fa40ff..04e375f 100644
--- a/doc/libwnck-docs.sgml
+++ b/doc/libwnck-docs.sgml
@@ -11,7 +11,7 @@
<title>Libwnck Overview</title>
<partintro>
<para>
- libwnck is the Window Navigator Construction Kit, a library for use in writing pagers, tasklists, and more generally applications that are dealing with window management.
+ libwnck is the Window Navigator Construction Kit, a library for use in writing pagers, tasklists, and more generally applications that are dealing with window management. It tries hard to respect the <ulink url="http://standards.freedesktop.org/wm-spec/wm-spec-latest.html">Extended Window Manager Hints specification</ulink> (EWMH). The <ulink url="http://tronche.com/gui/x/icccm/">Inter-Client Communication Conventions Manual</ulink> (ICCCM) is also a useful resource.
</para>
<para>
libwnck depends on the following libraries:
@@ -34,13 +34,15 @@
</part>
<!-- TODO
wnck_set_client_type() for pagers-like
+ add link to ewmh spec
+ mention that the window/classgroup/application/workspace/screen are owned by libwnck and should not be unref'ed.
+ mention wnck_screen_force_update()
-->
<part id="core">
<title>Libwnck Core Window Management Support</title>
<!-- TODO proofread + consistency -->
<xi:include href="xml/window.xml"/>
- <!-- TODO proofread + consistency -->
<xi:include href="xml/class-group.xml"/>
<!-- TODO proofread + consistency -->
<xi:include href="xml/application.xml"/>