Skip to content

Commit

Permalink
Fix typo in z_closure_zid_callback_t docs (#852)
Browse files Browse the repository at this point in the history
  • Loading branch information
sashacmc authored Jan 9, 2025
1 parent 8662b28 commit 39d9a46
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -603,13 +603,13 @@ See details at :ref:`owned_types_concept`
.. c:type:: z_loaned_closure_zid_t
.. c:type:: z_moved_closure_zid_t
.. c:type:: void (* z_closure_zid_callback_t)(z_loaned_zid_t * zid, void * arg);
.. c:type:: void (* z_closure_zid_callback_t)(const z_id_t * id, void * arg);
Function pointer type for handling Zenoh ID routers response.
Represents a callback function that is invoked when a zid is available for processing.

Parameters:
- **zid** - Pointer to a :c:type:`z_loaned_zid_t` representing the zid to be processed.
- **zid** - Pointer to a :c:type:`z_id_t` representing the zid to be processed.
- **arg** - A user-defined pointer to additional data that can be used during the processing of the zid.

Functions
Expand Down
2 changes: 1 addition & 1 deletion include/zenoh-pico/api/primitives.h
Original file line number Diff line number Diff line change
Expand Up @@ -1107,7 +1107,7 @@ z_result_t z_closure_zid(z_owned_closure_zid_t *closure, z_closure_zid_callback_
*
* Parameters:
* closure: Pointer to the :c:type:`z_loaned_closure_zid_t` to call.
* zid: Pointer to the :c:type:`z_loaned_zid_t` to pass to the closure.
* zid: Pointer to the :c:type:`z_id_t` to pass to the closure.
*/
void z_closure_zid_call(const z_loaned_closure_zid_t *closure, const z_id_t *id);

Expand Down

0 comments on commit 39d9a46

Please sign in to comment.