Skip to content

Commit

Permalink
Merge pull request mavlink#224 from wiml/master
Browse files Browse the repository at this point in the history
Updated doc comment for mavlink_parse_char()
  • Loading branch information
LorenzMeier committed Aug 4, 2014
2 parents 3688f8f + 4005268 commit a94dc1f
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion pymavlink/generator/C/include_v1.0/mavlink_helpers.h
Original file line number Diff line number Diff line change
Expand Up @@ -209,13 +209,18 @@ MAVLINK_HELPER void mavlink_update_checksum(mavlink_message_t* msg, uint8_t c)
* it could be successfully decoded. Checksum and other failures will be silently
* ignored.
*
* Messages are parsed into an internal buffer (one for each channel). When a complete
* message is received it is copies into *returnMsg and the channel's status is
* copied into *returnStats.
*
* @param chan ID of the current channel. This allows to parse different channels with this function.
* a channel is not a physical message channel like a serial port, but a logic partition of
* the communication streams in this case. COMM_NB is the limit for the number of channels
* on MCU (e.g. ARM7), while COMM_NB_HIGH is the limit for the number of channels in Linux/Windows
* @param c The char to barse
* @param c The char to parse
*
* @param returnMsg NULL if no message could be decoded, the message data else
* @param returnStats if a message was decoded, this is filled with the channel's stats
* @return 0 if no message could be decoded, 1 else
*
* A typical use scenario of this function call is:
Expand Down

0 comments on commit a94dc1f

Please sign in to comment.