diff options
| author | Érico Nogueira <erico.erc@gmail.com> | 2024-10-04 22:11:43 -0300 |
|---|---|---|
| committer | Eli Schwartz <eschwartz93@gmail.com> | 2024-11-01 00:00:57 -0400 |
| commit | d7e1d19285e99a602d6ded7d9d0b06bbb3ae6fa6 (patch) | |
| tree | 7e8d25d04eace7ba8c51788f140506be596a07dd /docs/markdown/Wayland-module.md | |
| parent | a608e56beba7eb1b3335e824ba2f1fe8453f0979 (diff) | |
| download | meson-d7e1d19285e99a602d6ded7d9d0b06bbb3ae6fa6.tar.gz | |
modules/wayland: document that scan_xml can take any protocol.
The quick example can be slightly misleading in implying that scan_xml
must use find_protocol, which is not the case. So explicitly mention it
in the scan_xml docs.
Diffstat (limited to 'docs/markdown/Wayland-module.md')
| -rw-r--r-- | docs/markdown/Wayland-module.md | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/docs/markdown/Wayland-module.md b/docs/markdown/Wayland-module.md index 679329373..3ffa58739 100644 --- a/docs/markdown/Wayland-module.md +++ b/docs/markdown/Wayland-module.md @@ -53,7 +53,8 @@ generated = wl_mod.scan_xml( include_core_only : true, ) ``` -This function accepts one or more arguments of either string or file type. +This function accepts one or more arguments of either string or file type, so +it can be used in conjunction with `find_protocol` or not. It takes the following keyword arguments: - `public` Optional arg that specifies the scope of the generated code. @@ -63,7 +64,7 @@ It takes the following keyword arguments: - `server` Optional arg that specifies if server side header file is generated. The default is false. - `include_core_only` Optional arg that specifies that generated headers only include - `wayland-<client|server>-core.h` instead of `wayland-<client|server>.h`. + `wayland-<client|server>-core.h` instead of `wayland-<client|server>.h`. The default is true. Since *0.64.0* **Returns**: a list of [[@custom_tgt]] in the order source, client side header, |