diff options
Diffstat (limited to 'docs/markdown')
| -rw-r--r-- | docs/markdown/Wayland-module.md | 3 | ||||
| -rw-r--r-- | docs/markdown/snippets/wayland_scan_xml_core_only_arg.md | 5 |
2 files changed, 8 insertions, 0 deletions
diff --git a/docs/markdown/Wayland-module.md b/docs/markdown/Wayland-module.md index 345c4e347..353bb6b7d 100644 --- a/docs/markdown/Wayland-module.md +++ b/docs/markdown/Wayland-module.md @@ -50,6 +50,7 @@ generated = wl_mod.scan_xml( client : true, server : true, public : false, + core_only : false, ) ``` This function accepts one or more arguments of either string or file type. @@ -61,6 +62,8 @@ It takes the following keyword arguments: generated. The default is true. - `server` Optional arg that specifies if server side header file is generated. The default is false. +- `core_only` Optional arg that specifies that generated headers only include + wayland-client-core.h instead of wayland-client.h. Since *0.64.0* **Returns**: a list of [[@custom_tgt]] in the order source, client side header, server side header. Generated header files have the name diff --git a/docs/markdown/snippets/wayland_scan_xml_core_only_arg.md b/docs/markdown/snippets/wayland_scan_xml_core_only_arg.md new file mode 100644 index 000000000..59f4e1b27 --- /dev/null +++ b/docs/markdown/snippets/wayland_scan_xml_core_only_arg.md @@ -0,0 +1,5 @@ +## Added core_only arg to wayland.scan_xml. + +The `scan_xml` function from the wayland module now has an optional bool +argument `core_only`, so that headers generated by wayland-scanner now +only include `wayland-client-core.h` instead of `wayland-client.h`. |