Add comment about usage to arrange_windows declaration

This commit is contained in:
Ryan Dwyer 2018-06-29 19:52:31 +10:00
parent d7169ee7ff
commit 3c81a900b7

View file

@ -16,6 +16,10 @@ void add_gaps(struct sway_container *c);
*
* Use this function if you need to arrange multiple sections of the tree in one
* transaction.
*
* You must set the desired state of the container before calling
* arrange_windows, then don't change any state-tracked properties in the
* container until you've called transaction_commit.
*/
void arrange_windows(struct sway_container *container,
struct sway_transaction *transaction);