clarify that stacking_below sucks

[chaz/openbox] / openbox / stacking.h

diff --git a/openbox/stacking.h b/openbox/stacking.h
index 132ef4902491e988ed8fd3a1fe24a59d1c606d77..8a8ca0999395b830eef4d2b3614030f29aee75bc 100644 (file)
--- a/openbox/stacking.h
+++ b/openbox/stacking.h
@@ -32,7 +32,13 @@ void stacking_add_nonintrusive(ObWindow *win);
 /*! Raises a window above all others in its stacking layer */
 void stacking_raise(ObWindow *window);
 
-/*! Lowers a client window below all others in its stacking layer */
+/*! Lowers a window below all others in its stacking layer */
 void stacking_lower(ObWindow *window);
 
+/*! Moves a window below another if its in the same layer.
+  This function does not enforce stacking rules IRT transients n such, and so
+  it should really ONLY be used to restore stacking orders from saved sessions
+*/
+void stacking_below(ObWindow *window, ObWindow *below);
+
 #endif