Add a description

This commit is contained in:
Marco Martin 2024-01-08 17:16:07 +01:00
parent 856843a22f
commit 8d16787360

View File

@ -187,10 +187,6 @@
<arg name="zone" type="int"/> <arg name="zone" type="int"/>
</request> </request>
<request name="set_exclusive_edge">
<arg name="edge" type="uint"/>
</request>
<request name="set_margin"> <request name="set_margin">
<description summary="sets a margin from the anchor point"> <description summary="sets a margin from the anchor point">
Requests that the surface be placed some distance away from the anchor Requests that the surface be placed some distance away from the anchor
@ -390,5 +386,14 @@
</description> </description>
<arg name="layer" type="uint" enum="zwlr_layer_shell_v1.layer" summary="layer to move this surface to"/> <arg name="layer" type="uint" enum="zwlr_layer_shell_v1.layer" summary="layer to move this surface to"/>
</request> </request>
<request name="set_exclusive_edge">
<description summary="set the edge the exclusive zone will be applied to">
Requests an edge for the exclusive zone to apply.
The edge must be one the surface is anchored to, otherwise a protocol error will be raised.
The exclusive edge will be automatically deduced from anchor points when possible, but when when the surface is anchored to a corner, it will be necessary to set it explicitly to disambiguate, as is not possible to deduce which one of the two corner edges should be used.
</description>
<arg name="edge" type="uint"/>
</request>
</interface> </interface>
</protocol> </protocol>