updated doxygen docu, added FIXMEs, fixed headers to 80chars width.

[i3/i3] / include / xinerama.h

diff --git a/include/xinerama.h b/include/xinerama.h
index b8a591c13e141194e810cd4bb63b33c179b354a4..5b01789f9cb61295aea7846e2a00e8772502a65e 100644 (file)
--- a/include/xinerama.h
+++ b/include/xinerama.h
@@ -16,10 +16,40 @@
 TAILQ_HEAD(screens_head, Screen);
 extern struct screens_head *virtual_screens;
 
+/**
+ * We have just established a connection to the X server and need the initial
+ * Xinerama information to setup workspaces for each screen.
+ *
+ */
 void initialize_xinerama(xcb_connection_t *conn);
+
+/**
+ * This is called when the rootwindow receives a configure_notify event and
+ * therefore the number/position of the Xinerama screens could have changed.
+ *
+ */
 void xinerama_requery_screens(xcb_connection_t *conn);
+
+/**
+ * Looks in virtual_screens for the i3Screen whose start coordinates are x, y
+ *
+ */
 i3Screen *get_screen_at(int x, int y, struct screens_head *screenlist);
+
+/**
+ * Looks in virtual_screens for the i3Screen which contains coordinates x, y
+ *
+ */
 i3Screen *get_screen_containing(int x, int y);
+
+/**
+ * Gets the screen which is the last one in the given direction, for example
+ * the screen on the most bottom when direction == D_DOWN, the screen most
+ * right when direction == D_RIGHT and so on.
+ *
+ * This function always returns a screen.
+ *
+ */
 i3Screen *get_screen_most(direction_t direction);
 
 #endif