Index: sources/canbus/messageinterpreter.cpp =================================================================== diff -u -rfee7fabf49befb065c89248c19e15efc9ca194e4 -rc5389647e2259e67f8e6d923f3481d7d3f4eab68 --- sources/canbus/messageinterpreter.cpp (.../messageinterpreter.cpp) (revision fee7fabf49befb065c89248c19e15efc9ca194e4) +++ sources/canbus/messageinterpreter.cpp (.../messageinterpreter.cpp) (revision c5389647e2259e67f8e6d923f3481d7d3f4eab68) @@ -28,16 +28,16 @@ MessageInterpreter::MessageInterpreter(QObject *parent) : QObject(parent) { } /*! - * \brief MessageInterpreter::interpretMessage \n - * \details This method will be called \n - * to interpret messages from UI regarding vActionId. \n - * \param vActionId - The Action Id of type GuiActionType \n - * to be interpreted to hex representation of Message ID. \n - * \param vData - The data which has to be sent over the CANBUS. \n - * \param vPayload - The Payload of the frame of Type QByteArray of hex values \n - * Which has been interpreted from vData of Type QVariantList \n - * \return true if the vActionId is valid. \n - * This return value will be used later for error handling. \n + * \brief MessageInterpreter::interpretMessage + * \details This method will be called + * to interpret messages from UI regarding vActionId. + * \param vActionId - The ActionID of type GuiActionType + * to be interpreted to hex representation of Message ID. + * \param vData - The data which has to be sent over the CANBUS. + * \param vPayload - The Payload of the frame of Type QByteArray of hex values + * Which has been interpreted from vData of Type QVariantList + * \return true if the vActionId is valid. + * This return value will be used later for error handling. */ bool MessageInterpreter::interpretMessage(const GuiActionType &vActionId, const QVariantList &vData, QByteArray &vPayload) { @@ -77,17 +77,17 @@ } /*! - * \brief MessageInterpreter::interpretMessage \n - * \details This method will call appropriate message interpreter \n - * for received messages from HD or DG regarding the Can_Id. \n - * \param vCan_Id - The Channel Id of the CANBUS frame. \n - * \param vMessage - The complete message of type Message which needs to be interpreted. \n - * \param vActionId - The ActionId of GuiActionType which will be extracted from vMessage. \n - * \param vData - The values of QVariantList which is understandable for UI \n - * and has been extracted from hex values of the CANBUS Message Payload \n - * regarding each Message Id definition. \n - * \return true if the message channel is in the range which can be interpreted, false otherwise. \n - * This return value will be used later to emit MessageDispatcher::didActionReceive signal or not \n + * \brief MessageInterpreter::interpretMessage + * \details This method will call appropriate message interpreter + * for received messages from HD or DG regarding the Can_Id. + * \param vCan_Id - The Channel Id of the CANBUS frame. + * \param vMessage - The complete message of type Message which needs to be interpreted. + * \param vActionId - The ActionId of GuiActionType which will be extracted from vMessage. + * \param vData - The values of QVariantList which is understandable for UI + * and has been extracted from hex values of the CANBUS Message Payload + * regarding each Message Id definition. + * \return true if the message channel is in the range which can be interpreted, false otherwise. + * This return value will be used later to emit MessageDispatcher::didActionReceive signal or not */ bool MessageInterpreter::interpretMessage(const Can_Id vCan_Id, const Message &vMessage, GuiActionType &vActionId, QVariantList &vData) { @@ -104,17 +104,17 @@ } /*! - * \brief MessageInterpreter::interpretMessage_HD \n - * \details This method will be called \n - * for received messages from HD to interpret the vMessage of type Message \n - * to vData of type QVariantList which UI understands regarding the Can_Id. \n - * \param vMessage - The complete message of type Message which needs to be interpreted. \n - * \param vActionId - The ActionId of GuiActionType which will be extracted from vMessage. \n - * \param vData - The values of QVariantList which is understandable for UI \n - * and has been extracted from hex values of the CANBUS Message Payload \n - * in vMessage of type Message regarding each Message Id definition. \n - * \return true if the message CANBUS channel is in the range which can be interpreted, false otherwise. \n - * This return value will be used later to emit MessageDispatcher::didActionReceive signal or not \n + * \brief MessageInterpreter::interpretMessage_HD + * \details This method will be called + * for received messages from HD to interpret the vMessage of type Message + * to vData of type QVariantList which UI understands regarding the Can_Id. + * \param vMessage - The complete message of type Message which needs to be interpreted. + * \param vActionId - The ActionId of GuiActionType which will be extracted from vMessage. + * \param vData - The values of QVariantList which is understandable for UI + * and has been extracted from hex values of the CANBUS Message Payload + * in vMessage of type Message regarding each Message Id definition. + * \return true if the message CANBUS channel is in the range which can be interpreted, false otherwise. + * This return value will be used later to emit MessageDispatcher::didActionReceive signal or not */ bool MessageInterpreter::interpretMessage_HD(const Message &vMessage, GuiActionType &vActionId, QVariantList &vData) { @@ -171,17 +171,17 @@ } /*! - * \brief MessageInterpreter::interpretMessage_DG \n - * \details This method will be called \n - * for received messages from DG to interpret the vMessage of type Message \n - * to vData of type QVariantList which UI understands regarding the Can_Id. \n - * \param vMessage - The complete message of type Message which needs to be interpreted. \n - * \param vActionId - The ActionId of GuiActionType which will be extracted from vMessage. \n - * \param vData - The values of QVariantList which is understandable for UI \n - * and has been extracted from hex values of the CANBUS Message Payload \n - * in vMessage of type Message regarding each Message Id definition. \n - * \return true if the message CANBUS channel is in the range which can be interpreted, false otherwise. \n - * This return value will be used later to emit MessageDispatcher::didActionReceive signal or not \n + * \brief MessageInterpreter::interpretMessage_DG + * \details This method will be called + * for received messages from DG to interpret the vMessage of type Message + * to vData of type QVariantList which UI understands regarding the Can_Id. + * \param vMessage - The complete message of type Message which needs to be interpreted. + * \param vActionId - The ActionId of GuiActionType which will be extracted from vMessage. + * \param vData - The values of QVariantList which is understandable for UI + * and has been extracted from hex values of the CANBUS Message Payload + * in vMessage of type Message regarding each Message Id definition. + * \return true if the message CANBUS channel is in the range which can be interpreted, false otherwise. + * This return value will be used later to emit MessageDispatcher::didActionReceive signal or not */ bool MessageInterpreter::interpretMessage_DG(const Message &vMessage, GuiActionType &vActionId, QVariantList &vData) { @@ -271,14 +271,14 @@ } /*! - * \brief MessageInterpreter::getPowerOffData \n - * \details This is the method which interprets the PowerOff message data \n - * in vMessage of type Message. \n - * to its elements of data. \n - * \param vMessage - The vMessage of type Message which contains all the data, \n - * require to be interpreted. \n - * \param vShowHide - The return value of extracted fro \n - * \return true if the data can be extracted as defined for PowerOff Message ID \n + * \brief MessageInterpreter::getPowerOffData + * \details This is the method which interprets the PowerOff message data + * in vMessage of type Message. + * to its elements of data. + * \param vMessage - The vMessage of type Message which contains all the data, + * require to be interpreted. + * \param vShowHide - The return value of extracted fro + * \return true if the data can be extracted as defined for PowerOff Message ID */ bool MessageInterpreter::getPowerOffData(const Message &vMessage, quint8 &vShowHide) { @@ -297,11 +297,11 @@ } /*! - * \brief MessageInterpreter::printUnhandled \n - * \details Prints out the formatted string of the vMessage of type Message \n - * In case the Message ID of received CANBUS message \n - * is known to the interpreter but has not been handled/implemented. \n - * \param vMessage - The message contains Unhandled Message ID \n + * \brief MessageInterpreter::printUnhandled + * \details Prints out the formatted string of the vMessage of type Message + * In case the Message ID of received CANBUS message + * is known to the interpreter but has not been handled/implemented. + * \param vMessage - The message contains Unhandled Message ID */ void MessageInterpreter::printUnhandled(const Message &vMessage) {