From cb310180fc5c9657c8bbb0fef7ef673bfd050e96 Mon Sep 17 00:00:00 2001 From: Dimitrios Stoupis <dimitris.apple@gmail.com> Date: Wed, 20 Mar 2019 15:25:56 +0000 Subject: [PATCH] Add missing documentation strings --- inc/MessageParser.hpp | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/inc/MessageParser.hpp b/inc/MessageParser.hpp index 678c1eec..e3b72134 100644 --- a/inc/MessageParser.hpp +++ b/inc/MessageParser.hpp @@ -50,8 +50,21 @@ public: */ Message parseRequestTC(String<ECSS_TC_REQUEST_STRING_SIZE> data); + /** + * @brief Overloaded version + * @param data A uint8_t array of the TC packet data + * @return Parsed message + */ Message parseRequestTC(uint8_t* data); + /** + * @brief Converts a TC packet of type Message to a String + * @details Convert a parsed TC message to a string in order to be used by the services + * @param message The Message object to be parsed to a String + * @return A String class containing the parsed TC request + * @attention The returned String has a fixed size, therefore the message size is considered + * fixed and equal to the ECSS_TC_REQUEST_STRING_SIZE definition. + */ String<ECSS_TC_REQUEST_STRING_SIZE> convertTCToStr(Message& message); private: -- GitLab