summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorVincent Untz <vuntz@gnome.org>2007-06-09 06:09:23 +0000
committerVincent Untz <vuntz@src.gnome.org>2007-06-09 06:09:23 +0000
commitfdef3851b2d5f6b7da3e876c29d6f93aa023cc3e (patch)
tree4ffaf9549f4abdc55e9ce568147efd5acc53de4f /doc
parentf6431a91f9431d5e2d5e5b9f65803cf63dc07024 (diff)
downloadlibwnck-fdef3851b2d5f6b7da3e876c29d6f93aa023cc3e.tar.gz
writing API doc is fun!
2007-06-09 Vincent Untz <vuntz@gnome.org> * doc/libwnck-docs.sgml: * doc/libwnck-sections.txt: * doc/tmpl/screen.sgml: * libwnck/application.c: * libwnck/class-group.c: * libwnck/screen.[ch]: * libwnck/util.h: * libwnck/window.c: * libwnck/workspace.c: writing API doc is fun! * libwnck/screen.c: (wnck_screen_get_workspace_index): updated for some clarity (wnck_screen_get_workspace_neighbor): ditto (wnck_screen_calc_workspace_layout): ditto, and if the number of workspaces is negative, calculate it (wnck_screen_net_wm_supports): make it really work on all screens, and not just the default screen * libwnck/window-action-menu.c: (wnck_create_window_action_menu): updated for some clarity svn path=/trunk/; revision=1286
Diffstat (limited to 'doc')
-rw-r--r--doc/libwnck-docs.sgml4
-rw-r--r--doc/libwnck-sections.txt4
-rw-r--r--doc/tmpl/screen.sgml40
3 files changed, 22 insertions, 26 deletions
diff --git a/doc/libwnck-docs.sgml b/doc/libwnck-docs.sgml
index 4d11471..4ac6fda 100644
--- a/doc/libwnck-docs.sgml
+++ b/doc/libwnck-docs.sgml
@@ -34,20 +34,16 @@
</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 ref'ed/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"/>
<xi:include href="xml/class-group.xml"/>
- <!-- TODO proofread + consistency -->
<xi:include href="xml/application.xml"/>
<xi:include href="xml/workspace.xml"/>
- <!-- TODO proofread + consistency -->
<xi:include href="xml/screen.xml"/>
</part>
diff --git a/doc/libwnck-sections.txt b/doc/libwnck-sections.txt
index ea8e2df..7533ea7 100644
--- a/doc/libwnck-sections.txt
+++ b/doc/libwnck-sections.txt
@@ -198,10 +198,10 @@ wnck_screen_get_height
wnck_screen_get_showing_desktop
wnck_screen_toggle_showing_desktop
wnck_screen_move_viewport
-WnckWorkspaceLayout
-wnck_screen_calc_workspace_layout
wnck_screen_try_set_workspace_layout
wnck_screen_release_workspace_layout
+WnckWorkspaceLayout
+wnck_screen_calc_workspace_layout
wnck_screen_free_workspace_layout
<SUBSECTION Private>
WnckScreenPrivate
diff --git a/doc/tmpl/screen.sgml b/doc/tmpl/screen.sgml
index 69b2090..59bba76 100644
--- a/doc/tmpl/screen.sgml
+++ b/doc/tmpl/screen.sgml
@@ -182,7 +182,7 @@ WnckScreen
</para>
@screen:
-@workspace:
+@space:
@Returns:
@@ -202,7 +202,7 @@ WnckScreen
</para>
@screen:
-@workspace:
+@space:
@direction:
@Returns:
@@ -334,48 +334,48 @@ WnckScreen
@y:
-<!-- ##### STRUCT WnckWorkspaceLayout ##### -->
+<!-- ##### FUNCTION wnck_screen_try_set_workspace_layout ##### -->
<para>
</para>
+@screen:
+@current_token:
@rows:
-@cols:
-@grid:
-@grid_area:
-@current_row:
-@current_col:
+@columns:
+@Returns:
-<!-- ##### FUNCTION wnck_screen_calc_workspace_layout ##### -->
+
+<!-- ##### FUNCTION wnck_screen_release_workspace_layout ##### -->
<para>
</para>
@screen:
-@num_workspaces:
-@current_space:
-@layout:
+@current_token:
-<!-- ##### FUNCTION wnck_screen_try_set_workspace_layout ##### -->
+<!-- ##### STRUCT WnckWorkspaceLayout ##### -->
<para>
</para>
-@screen:
-@current_token:
@rows:
-@columns:
-@Returns:
-
+@cols:
+@grid:
+@grid_area:
+@current_row:
+@current_col:
-<!-- ##### FUNCTION wnck_screen_release_workspace_layout ##### -->
+<!-- ##### FUNCTION wnck_screen_calc_workspace_layout ##### -->
<para>
</para>
@screen:
-@current_token:
+@num_workspaces:
+@space_index:
+@layout:
<!-- ##### FUNCTION wnck_screen_free_workspace_layout ##### -->