fdo-mirrors/libei
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/libinput/libei.git synced 2026-01-07 20:30:17 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc/proto: put a standard blurb in for the destructor-type requests

Browse source 
Should eventually have a separate protocol documentation section for
this and point to it, but this will do for now.
This commit is contained in:
Peter Hutterer 2023-03-07 19:29:08 +10:00
parent 59ab84669f
commit fb5b607c13
1 changed files with 23 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
doc/protocol/interface.md.tmpl
View file

@ -59,6 +59,17 @@ Enum names are shown here in uppercase. The exact name depends on the language b
{% endfor %}
{% endif %}
{% if request.is_destructor %}
{% raw %}
{{% notice default "Destructor" "skull-crossbones" %}}
{% endraw %}
Immediately after sending this request, the object is considered destroyed
by the EIS implementation. It must no longer be used by the client.
{% raw %}
{{% /notice %}}
{% endraw %}
{% endif %}
{{request.description.text|ei_escape_names}}
{% endfor %}
@ -84,11 +95,22 @@ Enum names are shown here in uppercase. The exact name depends on the language b
{% endfor %}
{% endif %}
{% if event.is_destructor %}
{% raw %}
{{% notice default "Destructor" "skull-crossbones" %}}
{% endraw %}
Immediately after sending this request, the object is considered destroyed
by the EIS implementation. It must no longer be used by the client.
{% raw %}
{{% /notice %}}
{% endraw %}
{% endif %}
{{event.description.text|ei_escape_names}}
{% endfor %}
{% endif %}
{% endif %}
{% endfor %}