Add more documentation to functions/header files

[i3/i3] / include / render.h

diff --git a/include/render.h b/include/render.h
index 26ae8d51985707e9ac901712c30d9a9cdda5ac5f..849f214e5f1ef379b57b20fa86642ba1dbcd7bed 100644 (file)
--- a/include/render.h
+++ b/include/render.h
@@ -5,6 +5,14 @@
 #ifndef _RENDER_H
 #define _RENDER_H
 
+/**
+ * "Renders" the given container (and its children), meaning that all rects are
+ * updated correctly. Note that this function does not call any xcb_*
+ * functions, so the changes are completely done in memory only (and
+ * side-effect free). As soon as you call x_push_changes(), the changes will be
+ * updated in X11.
+ *
+ */
 void render_con(Con *con);
 
 #endif