C/include_v{1,2}.0/mavlink_helpers.h: improve docstring of mavlink_finalize_message* functions#1194
Open
mr3screen wants to merge 2 commits into
Open
C/include_v{1,2}.0/mavlink_helpers.h: improve docstring of mavlink_finalize_message* functions#1194mr3screen wants to merge 2 commits into
mr3screen wants to merge 2 commits into
Conversation
…nalize_message* functions
A programmer needs to know how large the buffer needs to be. Internal MAVLink knowledge is needed to know the exact length a specific message needs. It's easier for them if we mention MAVLINK_MAX_PACKET_LEN always suffices.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The mavlink_finalize_message* family of functions is difficult to use for newcomers as it's not immediately clear which one should be used, and when.
I added cross references to the other functions with an explanation of when they should be used and copied the preconditions of *_buffer to all functions.
Also mavlink_msg_to_send_buffer didn't mention the required buffer size.