Index: sources/canbus/messagehandler.cpp =================================================================== diff -u -rfee7fabf49befb065c89248c19e15efc9ca194e4 -rc5389647e2259e67f8e6d923f3481d7d3f4eab68 --- sources/canbus/messagehandler.cpp (.../messagehandler.cpp) (revision fee7fabf49befb065c89248c19e15efc9ca194e4) +++ sources/canbus/messagehandler.cpp (.../messagehandler.cpp) (revision c5389647e2259e67f8e6d923f3481d7d3f4eab68) @@ -45,7 +45,7 @@ /*! * \brief MessageHandler connections definition - * \details Initializes the required signal/slot connection between this class and other objects\n + * \details Initializes the required signal/slot connection between this class and other objects * to be able to communicate. */ void MessageHandler::initConnections() @@ -60,14 +60,14 @@ } /*! - * \brief MessageHandler::transmitFrame \n - * \details Prepares a frame to be transmitted \n - * and emit signal didFrameTransmit with the frame as its argument \n - * \param vFrameId - Channel id of the CANBUS frame \n - * \param vData - The Data this frame is going to carry \n - * \note This frame is created by MessageBuilder \n - * and it can be one of the frames of a message \n - * which has been chopped into frames. \n + * \brief MessageHandler::transmitFrame + * \details Prepares a frame to be transmitted + * and emit signal didFrameTransmit with the frame as its argument + * \param vFrameId - Channel id of the CANBUS frame + * \param vData - The Data this frame is going to carry + * \note This frame is created by MessageBuilder + * and it can be one of the frames of a message + * which has been chopped into frames. */ void MessageHandler::transmitFrame(Can_Id vFrameId, const QByteArray &vData) { @@ -82,14 +82,14 @@ } /*! - * \brief MessageHandler::checkChannel \n - * \details Checks for the channel id of the received frame \n - * which needs to be handled or ignored. \n - * \param vFrameId - Channel id of the frame \n - * \param vOK - will be set to true if the channel \n - * is valid and a variable has been passed to \n - * \return The Category if the channels from the UI \n - * perspective \ref MessageHandler::ChannelGroup \n + * \brief MessageHandler::checkChannel + * \details Checks for the channel id of the received frame + * which needs to be handled or ignored. + * \param vFrameId - Channel id of the frame + * \param vOK - will be set to true if the channel + * is valid and a variable has been passed to + * \return The Category if the channels from the UI + * perspective MessageHandler::ChannelGroup */ MessageHandler::ChannelGroup MessageHandler::checkChannel(quint32 vFrameId, bool *vOK) { @@ -127,12 +127,12 @@ } /*! - * \brief MessageHandler::onFrameTransmit \n - * \details This the slot connected to the MessageDispatcher didFrameTransmit signal. \n - * When a frame needs to be send to CANBUS, \n - * this slot will call transmitFrame method to do the job. \n - * \param vCan_ID - CANBUS Can Id target of the frame. \n - * \param vData - The data which this frame will carry. \n + * \brief MessageHandler::onFrameTransmit + * \details This the slot connected to the MessageDispatcher didFrameTransmit signal. + * When a frame needs to be send to CANBUS, + * this slot will call transmitFrame method to do the job. + * \param vCan_ID - CANBUS Can Id target of the frame. + * \param vData - The data which this frame will carry. */ void MessageHandler::onFrameTransmit(Can_Id vCan_ID, const QByteArray &vData) { @@ -141,10 +141,10 @@ /*! * \brief MessageHandler::onFrameReceive - * \details This the slot connected to the CanInterface didFrameReceive signal. \n - * When a frame received over the CANBUS, \n - * this slot will be called to check the channel if should be listened to. \n - * and will emit didFrameReceive if should be handled and ignored otherwise. \n + * \details This the slot connected to the CanInterface didFrameReceive signal. + * When a frame received over the CANBUS, + * this slot will be called to check the channel if should be listened to. + * and will emit didFrameReceive if should be handled and ignored otherwise. * \param vFrame - The frame has to be sent */ void MessageHandler::onFrameReceive(const QCanBusFrame &vFrame)