diff options
author | Ryan Dwyer <ryandwyer1@gmail.com> | 2018-06-29 19:52:31 +1000 |
---|---|---|
committer | Ryan Dwyer <ryandwyer1@gmail.com> | 2018-06-29 19:52:31 +1000 |
commit | 3c81a900b766dd2c049ba7af6e603805893e0926 (patch) | |
tree | 8894948a4bf9ed4f98f1bb40faeb3ee480ef471e /include | |
parent | Replace list_empty with a simple alternative (diff) | |
download | sway-3c81a900b766dd2c049ba7af6e603805893e0926.tar.gz sway-3c81a900b766dd2c049ba7af6e603805893e0926.tar.zst sway-3c81a900b766dd2c049ba7af6e603805893e0926.zip |
Add comment about usage to arrange_windows declaration
Diffstat (limited to 'include')
-rw-r--r-- | include/sway/tree/arrange.h | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/include/sway/tree/arrange.h b/include/sway/tree/arrange.h index 6c8c0dba..58235642 100644 --- a/include/sway/tree/arrange.h +++ b/include/sway/tree/arrange.h | |||
@@ -16,6 +16,10 @@ void add_gaps(struct sway_container *c); | |||
16 | * | 16 | * |
17 | * Use this function if you need to arrange multiple sections of the tree in one | 17 | * Use this function if you need to arrange multiple sections of the tree in one |
18 | * transaction. | 18 | * transaction. |
19 | * | ||
20 | * You must set the desired state of the container before calling | ||
21 | * arrange_windows, then don't change any state-tracked properties in the | ||
22 | * container until you've called transaction_commit. | ||
19 | */ | 23 | */ |
20 | void arrange_windows(struct sway_container *container, | 24 | void arrange_windows(struct sway_container *container, |
21 | struct sway_transaction *transaction); | 25 | struct sway_transaction *transaction); |