Skip to content

Commit

Permalink
Merge pull request #580 from dora-rs/add_comment
Browse files Browse the repository at this point in the history
add a comment on read_dora_input_id
  • Loading branch information
phil-opp authored Jul 11, 2024
2 parents 8d63e81 + 2e426e5 commit 6d3638e
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion apis/c/node/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -117,11 +117,14 @@ pub enum EventType {
///
/// ## Safety
///
/// The `event` argument must be a dora event received through
/// - The `event` argument must be a dora event received through
/// [`dora_next_event`]. The event must be still valid, i.e., not
/// freed yet. The returned `out_ptr` must not be used after
/// freeing the `event`, since it points directly into the event's
/// memory.
///
/// - Note: `Out_ptr` is not a null-terminated string. The length of the string
/// is given by `out_len`.
#[no_mangle]
pub unsafe extern "C" fn read_dora_input_id(
event: *const (),
Expand Down

0 comments on commit 6d3638e

Please sign in to comment.