Add more documentation to functions/header files

[i3/i3] / include / window.h

diff --git a/include/window.h b/include/window.h
index a126a36c99f426c92e7b933b745ff8fcb5e52333..044bde708682060f6bfe604ba12e381e8f26cb93 100644 (file)
--- a/include/window.h
+++ b/include/window.h
@@ -1,8 +1,27 @@
 #ifndef _WINDOW_H
 #define _WINDOW_H
 
+/**
+ * Updates the WM_CLASS (consisting of the class and instance) for the
+ * given window.
+ *
+ */
 void window_update_class(i3Window *win, xcb_get_property_reply_t *prop);
+
+/**
+ * Updates the name by using _NET_WM_NAME (encoded in UTF-8) for the given
+ * window. Further updates using window_update_name_legacy will be ignored.
+ *
+ */
 void window_update_name(i3Window *win, xcb_get_property_reply_t *prop);
+
+/**
+ * Updates the name by using WM_NAME (encoded in COMPOUND_TEXT). We do not
+ * touch what the client sends us but pass it to xcb_image_text_8. To get
+ * proper unicode rendering, the application has to use _NET_WM_NAME (see
+ * window_update_name()).
+ *
+ */
 void window_update_name_legacy(i3Window *win, xcb_get_property_reply_t *prop);
 
 #endif