Add documentation

This commit is contained in:
Stefano Calabretti
2022-02-23 13:21:34 +01:00
parent dd53c8f4cc
commit f5c8353245
11 changed files with 189 additions and 34 deletions
+14
View File
@@ -1,3 +1,17 @@
/**
* @file mmr_can_message_id.h
* @brief
* This header contains the message id declarations.
*
* Message ids identify a message, allowing the receiver
* to take appropriate action when parsing one.
*
* For example, a can packet with message id set to
* MMR_CAN_MESSAGE_ID_POINT might be interpreted as
* a message carrying a struct Point { int x; int y; };,
* and thus deserialized accordingly.
*/
#ifndef INC_MMR_CAN_MESSAGE_ID_H_
#define INC_MMR_CAN_MESSAGE_ID_H_