From f32cccdd5bca906bb0c956e108af8b6e79f3fc6b Mon Sep 17 00:00:00 2001 From: Jean-Roland Date: Thu, 11 Jan 2024 17:10:37 +0100 Subject: [PATCH] doc: clarify function use --- include/zenoh-pico/api/primitives.h | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/include/zenoh-pico/api/primitives.h b/include/zenoh-pico/api/primitives.h index 57fc6fc5d..8df6ba1c0 100644 --- a/include/zenoh-pico/api/primitives.h +++ b/include/zenoh-pico/api/primitives.h @@ -93,19 +93,20 @@ z_owned_str_t z_keyexpr_to_string(z_keyexpr_t keyexpr); * * Returns: * The :c:type:`z_bytes_t` pointing to key expression string representation if it's possible - */ z_bytes_t z_keyexpr_as_bytes(z_keyexpr_t keyexpr); /** * Indicates if the key expression has been declared but don't guarantee it's still in session. * + * If given keyexpr was declared, to retrieve the keyexpr string representation the user must use + * :c:func:zp_keyexpr_resolve + * * Parameters: * keyexpr: A loaned instance of :c:type:`z_keyexpr_t` * * Returns: * Returns ``true`` if the keyexpr was declared or ``false`` otherwise. - */ _Bool zp_keyexpr_was_declared(const z_keyexpr_t *keyexpr);