summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorVincent Untz <vuntz@gnome.org>2007-06-06 19:39:54 +0000
committerVincent Untz <vuntz@src.gnome.org>2007-06-06 19:39:54 +0000
commit7b8bd21d7a909bfafe865105c02b5a46fb6dda59 (patch)
tree7b85642174e2892dc26e06519234ac874bf0881f /doc
parente4851b860f827b5e06b3e92c3350fb22a300116d (diff)
downloadlibwnck-7b8bd21d7a909bfafe865105c02b5a46fb6dda59.tar.gz
small improvements to documentation
2007-06-06 Vincent Untz <vuntz@gnome.org> * libwnck/util.[ch]: * libwnck/window-action-menu.c: * doc/*: small improvements to documentation svn path=/trunk/; revision=1282
Diffstat (limited to 'doc')
-rw-r--r--doc/libwnck-docs.sgml23
-rw-r--r--doc/libwnck-sections.txt8
-rw-r--r--doc/tmpl/util.sgml18
-rw-r--r--doc/tmpl/window-action-menu.sgml2
4 files changed, 36 insertions, 15 deletions
diff --git a/doc/libwnck-docs.sgml b/doc/libwnck-docs.sgml
index fef03d7..0fa40ff 100644
--- a/doc/libwnck-docs.sgml
+++ b/doc/libwnck-docs.sgml
@@ -32,38 +32,39 @@
</para>
</partintro>
</part>
+ <!-- TODO
+ wnck_set_client_type() for pagers-like
+ -->
<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"/>
+ <!-- TODO proofread + consistency -->
<xi:include href="xml/workspace.xml"/>
+ <!-- TODO proofread + consistency -->
<xi:include href="xml/screen.xml"/>
</part>
<part id="widgets">
<title>Libwnck Widgets</title>
+ <!-- TODO proofread + consistency -->
<xi:include href="xml/pager.xml"/>
+ <!-- TODO proofread + consistency -->
<xi:include href="xml/selector.xml"/>
+ <!-- TODO proofread + consistency -->
<xi:include href="xml/tasklist.xml"/>
</part>
<part id="utils">
<title>Libwnck Utilities</title>
<xi:include href="xml/window-action-menu.xml"/>
+ <!-- TODO proofread + consistency -->
<xi:include href="xml/util.xml"/>
</part>
- <!-- Things that should not be in documentation because it's private
- or it's not interesting
- <xi:include href="xml/pager-accessible-factory.xml"/>
- <xi:include href="xml/pager-accessible.xml"/>
- <xi:include href="xml/workspace-accessible-factory.xml"/>
- <xi:include href="xml/workspace-accessible.xml"/>
- <xi:include href="xml/private.xml"/>
- <xi:include href="xml/xutils.xml"/>
- <xi:include href="xml/wnck-enum-types.xml"/>
- -->
-
</book>
diff --git a/doc/libwnck-sections.txt b/doc/libwnck-sections.txt
index 7a31f96..cf0fa3e 100644
--- a/doc/libwnck-sections.txt
+++ b/doc/libwnck-sections.txt
@@ -1,3 +1,4 @@
+<INCLUDE>libwnck/libwnck.h</INCLUDE>
# Core
<SECTION>
@@ -95,8 +96,8 @@ WnckWindowClass
<SECTION>
<FILE>class-group</FILE>
-<TITLE>Wnck</TITLE>
<TITLE>WnckClassGroup</TITLE>
+<INCLUDE>libwnck/libwnck.h, libwnck/class-group.h</INCLUDE>
WnckClassGroup
wnck_class_group_get
wnck_class_group_get_res_class
@@ -296,14 +297,17 @@ WnckTasklistClass
<SECTION>
<FILE>window-action-menu</FILE>
+<TITLE>Window Action Menu</TITLE>
wnck_create_window_action_menu
</SECTION>
<SECTION>
<FILE>util</FILE>
+<TITLE>Miscellaneous Functions</TITLE>
WnckClientType
wnck_gtk_window_set_dock_type
wnck_set_client_type
+WnckResourceUsage
wnck_xid_read_resource_usage
wnck_pid_read_resource_usage
#</SECTION>
@@ -364,7 +368,6 @@ WnckWorkspaceAccessibleFactoryClass
#
#<SECTION>
#<FILE>workspace-accessible</FILE>
-WNCK_WORKSPACE_TYPE_ACCESSIBLE
#<TITLE>WnckWorkspaceAccessible</TITLE>
WnckWorkspaceAccessible
wnck_workspace_accessible_new
@@ -373,6 +376,7 @@ wnck_workspace_accessible_get_type
#<SUBSECTION Standard>
WNCK_WORKSPACE_ACCESSIBLE
WNCK_IS_WORKSPACE_ACCESSIBLE
+WNCK_WORKSPACE_TYPE_ACCESSIBLE
WNCK_WORKSPACE_ACCESSIBLE_CLASS
WNCK_IS_WORKSPACE_ACCESSIBLE_CLASS
WNCK_WORKSPACE_ACCESSIBLE_GET_CLASS
diff --git a/doc/tmpl/util.sgml b/doc/tmpl/util.sgml
index 81f05db..b526af4 100644
--- a/doc/tmpl/util.sgml
+++ b/doc/tmpl/util.sgml
@@ -1,5 +1,5 @@
<!-- ##### SECTION Title ##### -->
-util
+Miscellaneous Functions
<!-- ##### SECTION Short_Description ##### -->
@@ -41,6 +41,22 @@ util
@ewmh_sourceindication_client_type:
+<!-- ##### STRUCT WnckResourceUsage ##### -->
+<para>
+
+</para>
+
+@n_pixmaps:
+@n_windows:
+@n_gcs:
+@n_pictures:
+@n_glyphsets:
+@n_fonts:
+@n_colormap_entries:
+@n_passive_grabs:
+@n_cursors:
+@n_other:
+
<!-- ##### FUNCTION wnck_xid_read_resource_usage ##### -->
<para>
diff --git a/doc/tmpl/window-action-menu.sgml b/doc/tmpl/window-action-menu.sgml
index 7fd9721..b19f7a7 100644
--- a/doc/tmpl/window-action-menu.sgml
+++ b/doc/tmpl/window-action-menu.sgml
@@ -1,5 +1,5 @@
<!-- ##### SECTION Title ##### -->
-window-action-menu
+Window Action Menu
<!-- ##### SECTION Short_Description ##### -->