Add more documentation to functions/header files

[i3/i3] / include / x.h

diff --git a/include/x.h b/include/x.h
index 85dfc3ce3d1be462368616dcb898de7416b1d7c3..91af5014b6273fbd70328856fe9f9e871c5bcfa6 100644 (file)
--- a/include/x.h
+++ b/include/x.h
@@ -5,11 +5,51 @@
 #ifndef _X_H
 #define _X_H
 
+/**
+ * Initializes the X11 part for the given container. Called exactly once for
+ * every container from con_new().
+ *
+ */
 void x_con_init(Con *con);
+
+/**
+ * Re-initializes the associated X window state for this container. You have
+ * to call this when you assign a client to an empty container to ensure that
+ * its state gets updated correctly.
+ *
+ */
+void x_reinit(Con *con);
+
+/**
+ * Kills the window decoration associated with the given container.
+ *
+ */
 void x_con_kill(Con *con);
+
+/**
+ * Kills the given X11 window using WM_DELETE_WINDOW (if supported).
+ *
+ */
 void x_window_kill(xcb_window_t window);
+
+/**
+ * Draws the decoration of the given container onto its parent.
+ *
+ */
 void x_draw_decoration(Con *con);
+
+/**
+ * Pushes all changes (state of each node, see x_push_node() and the window
+ * stack) to X11.
+ *
+ */
 void x_push_changes(Con *con);
+
+/**
+ * Raises the specified container in the internal stack of X windows. The
+ * next call to x_push_changes() will make the change visible in X11.
+ *
+ */
 void x_raise_con(Con *con);
 
 #endif