Mirror/ardupilot
5
0
Fork 0
mirror of https://github.com/ArduPilot/ardupilot synced 2025-01-03 06:28:27 -04:00
Code Issues Packages Projects Releases Wiki Activity

AP_Logger: add example of documentation for a log structure

Browse Source
This commit is contained in:
Peter Barker 2019-10-18 14:07:06 +11:00 committed by Peter Barker
parent 6c56f24e30
commit 55ee3362b9
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
libraries/AP_Logger/LogStructure.h
View File

@ -1317,6 +1317,16 @@ struct PACKED log_Arm_Disarm {
#define ARSP_UNITS "snPOPP----"
#define ARSP_MULTS "F00B00----"
// @LoggerMessage: FMT
// @Description: Message defining the format of messages in this file
// @URL: https://ardupilot.org/dev/docs/code-overview-adding-a-new-log-message.html
// @Field: type: unique-to-this-log identifier for message being defined
// @Field: length: the number of bytes taken up by this message (including all headers)
// @Field: name: name of the message being defined
// @Field: format: character string defining the C-storage-type of the fields in this message
// @Field: labels: the labels of the message being defined
// messages for all boards
#define LOG_BASE_STRUCTURES \
{ LOG_FORMAT_MSG, sizeof(log_Format), \