Index: sources/canbus/messageglobals.h =================================================================== diff -u -rfee7fabf49befb065c89248c19e15efc9ca194e4 -rc5389647e2259e67f8e6d923f3481d7d3f4eab68 --- sources/canbus/messageglobals.h (.../messageglobals.h) (revision fee7fabf49befb065c89248c19e15efc9ca194e4) +++ sources/canbus/messageglobals.h (.../messageglobals.h) (revision c5389647e2259e67f8e6d923f3481d7d3f4eab68) @@ -23,8 +23,9 @@ namespace Can { /*! - * \brief Payload Length - * \details List of each action acceptable data length in the whole message packet. + * \brief Payload Length + * \details List of each ActionID required data (in byte) length in the message. + * So the data collector has to collect this amount of bytes as payload of a message. */ const QHash payloadLen { {GuiActionType::PowerOff , 1}, @@ -34,7 +35,7 @@ }; /*! - * \brief The Payload_Data enum + * \brief The Payload_Data enum * \details Global information for message packet. */ enum Payload_Data : quint8 { @@ -43,7 +44,7 @@ }; /*! - * \brief The Frame_Data enum + * \brief The Frame_Data enum * \details Global information for each message frame. */ enum Frame_Data : quint8 { @@ -53,13 +54,13 @@ eLenMaxData = 255, ///< Maximum data length in a Can Message since data length value kept in one byte eLenSyncByte = 1, ///< The length of Sync byte at the beginning of each header frame - eLenActionId = 2, ///< The length of Message ID bytes (2) at the beginning of each header frame after sync - eLenLength = 1, ///< The length of data length value byte at the beginning of each header frame after Message ID + eLenActionId = 2, ///< The length of MessageID bytes (2) at the beginning of each header frame after sync + eLenLength = 1, ///< The length of data length value byte at the beginning of each header frame after MessageID }; /*! - * \brief The Can_Id enum - * \details The Valid Can Bus Message Id of each frame + * \brief The Can_Id enum + * \details The Valid Can Bus MessageID of each frame */ enum Can_Id : quint16 { eChlid_NONE = 0x000, @@ -87,8 +88,8 @@ }; /*! - * \brief The Message struct - * \details The message structure after it's been glued together. + * \brief The Message struct + * \details The message structure after it's been converted form hex bytes to meaningful struct for UI. */ struct Message { // TODO : Should be converted to MessageModel class // no time left for now !!! Can_Id can_id;