Skip to content

Commit

Permalink
Add extra note in docstring about terminating null character
Browse files Browse the repository at this point in the history
Signed-off-by: Emerson Knapp <emerson.b.knapp@gmail.com>
  • Loading branch information
emersonknapp committed Feb 1, 2023
1 parent 0025579 commit d6cc794
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion rcl/include/rcl/type_version_hash.h
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,9 @@ extern "C"
*
* \param[in] type_description Prefilled TypeDescription message to be translated
* \param[out] output_repr An initialized empty char array that will be filled with
* the JSON representation of type_description
* the JSON representation of type_description. Note that output_repr will have a
* terminating null character, which should be omitted from hashing. To do so, use
* (output_repr.buffer_length - 1) or strlen(output_repr.buffer) for the size of data to hash.
* \return RCL_RET_OK on success, RCL_RET_ERROR if any problems occur in translation
*/
RCL_PUBLIC
Expand Down

0 comments on commit d6cc794

Please sign in to comment.