Skip to content

Commit

Permalink
modules/wayland: document that scan_xml can take any protocol.
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
ericonr committed Oct 5, 2024
1 parent b7ce7c2 commit 000fe8f
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions docs/markdown/Wayland-module.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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,
Expand Down

0 comments on commit 000fe8f

Please sign in to comment.