bartoszek/zephyr
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: fix code samples in dns_sd documentation so that they compile

Browse Source 
Macros for registering TCP and UDP services accept a port as a number,
not a pointer. Also added missing parameter to UDP service macro, and
missing type of bar_txt

Signed-off-by: Matt Rodgers <mrodgers@witekio.com>
This commit is contained in:
Matt Rodgers 2024-08-06 16:10:33 +01:00 committed by Chris Friedt
parent 9de1342f99
commit d28080e277
1 changed files with 3 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
include/zephyr/net/dns_sd.h
View File

@ -131,18 +131,15 @@ extern "C" {
* Example (with TXT):
* @code{.c}
* #include <zephyr/net/dns_sd.h>
* static const bar_txt[] = {
* static const char bar_txt[] = {
* "\x06" "path=/"
* "\x0f" "this=is the way"
* "\x0e" "foo or=foo not"
* "\x17" "this=has\0embedded\0nulls"
* "\x04" "true"
* };
* // Possibly use an ephemeral port
* // Possibly only assign bar_port when the service is running
* static uint16_t bar_port;
* DNS_SD_REGISTER_TCP_SERVICE(bar, CONFIG_NET_HOSTNAME,
* "_bar", "local", bar_txt, &bar_port);
* "_bar", "local", bar_txt, 4242);
* @endcode
*
* TXT records begin with a single length byte (hex-encoded)
@ -177,10 +174,8 @@ extern "C" {
* Example (no TXT):
* @code{.c}
* #include <zephyr/net/dns_sd.h>
* #include <zephyr/sys/byteorder.h>
* static const foo_port = sys_cpu_to_be16(4242);
* DNS_SD_REGISTER_UDP_SERVICE(foo, CONFIG_NET_HOSTNAME,
* "_foo", DNS_SD_EMPTY_TXT, &foo_port);
* "_foo", "local", DNS_SD_EMPTY_TXT, 4242);
* @endcode
*
* @param id variable name for the DNS-SD service record