doc: add frozen=true interface attribute

This is useful for scanners that use knowledge of the object creation
hierarchy such as zig-wayland [1]. Currently zig-wayland uses a
hardcoded list of frozen interfaces.

[1]: https://codeberg.org/ifreund/zig-wayland

Signed-off-by: Isaac Freund <mail@isaacfreund.com>
This commit is contained in:
Isaac Freund 2026-02-24 12:43:43 +01:00 committed by Simon Ser
parent 4d13366fcc
commit a58bcd7481
3 changed files with 14 additions and 3 deletions

View file

@ -4,6 +4,7 @@
<!ELEMENT interface (description?,(request|event|enum)+)>
<!ATTLIST interface name CDATA #REQUIRED>
<!ATTLIST interface version CDATA #REQUIRED>
<!ATTLIST interface frozen CDATA #IMPLIED>
<!ELEMENT request (description?,arg*)>
<!ATTLIST request name CDATA #REQUIRED>
<!ATTLIST request type CDATA #IMPLIED>

View file

@ -173,7 +173,7 @@
</event>
</interface>
<interface name="wl_callback" version="1">
<interface name="wl_callback" version="1" frozen="true">
<description summary="callback object">
Clients can handle the 'done' event to get notified when
the related request is done.
@ -503,7 +503,7 @@
</request>
</interface>
<interface name="wl_buffer" version="1">
<interface name="wl_buffer" version="1" frozen="true">
<description summary="content for a wl_surface">
A buffer provides the content for a wl_surface. Buffers are
created through factory interfaces such as wl_shm, wp_linux_buffer_params