Skip to content

Commit

Permalink
to_string: improve the copy_string documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
spalmer25 committed Apr 22, 2024
1 parent 7702e73 commit 9f00c8d
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions src/to_string.h
Original file line number Diff line number Diff line change
Expand Up @@ -98,13 +98,13 @@ int hwm_to_string(char *dest, size_t dest_size, high_watermark_t const *const hw
int hwm_status_to_string(char *dest, size_t dest_size, volatile bool const *hwm_disabled);

/**
* @brief Copies a string in a buffer
* @brief Copies a string in a buffer.
*
* `src` may be unrelocated pointer to rodata.
* Returns -1 if the string is too large to fit in the buffer
*
* @param dest: output buffer
* @param dest_size: size of the buffer
* @param src: input to copy
* @param dest_size: size of the output buffer
* @param src: string to copy
* @return int: size of the result, negative integer on failure
*/
int copy_string(char *const dest, size_t const dest_size, char const *const src);

0 comments on commit 9f00c8d

Please sign in to comment.