Skip to content

Commit

Permalink
doc: clarify function use
Browse files Browse the repository at this point in the history
  • Loading branch information
jean-roland committed Jan 12, 2024
1 parent 10d2f2e commit f32cccd
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions include/zenoh-pico/api/primitives.h
Original file line number Diff line number Diff line change
Expand Up @@ -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);

Expand Down

0 comments on commit f32cccd

Please sign in to comment.