Correct doxygen syntax in phosphor-net-ipmid
Resolves openbmc/openbmc#1147
Change-Id: I57ab1b09ec1bf308cc3d97cd30b2d18564beb38b
Signed-off-by: Tom Joseph <tomjoseph@in.ibm.com>
diff --git a/message_handler.hpp b/message_handler.hpp
index 882a077..11cc42a 100644
--- a/message_handler.hpp
+++ b/message_handler.hpp
@@ -26,7 +26,7 @@
Handler(Handler&&) = default;
Handler& operator=(Handler&&) = default;
- /*
+ /**
* @brief Receive the IPMI packet
*
* Read the data on the socket, get the parser based on the Session
@@ -37,7 +37,7 @@
*/
std::unique_ptr<Message> receive();
- /*
+ /**
* @brief Process the incoming IPMI message
*
* The incoming message payload is handled and the command handler for
@@ -93,7 +93,7 @@
parser::SessionHeader sessionHeader = parser::SessionHeader::IPMI20;
- /*
+ /**
* @brief Create the response IPMI message
*
* The IPMI outgoing message is constructed out of payload and the
@@ -116,7 +116,7 @@
return outMessage;
}
- /*
+ /**
* @brief Extract the command from the IPMI payload
*
* @param[in] message - Incoming message
@@ -125,7 +125,7 @@
*/
uint32_t getCommand(Message& message);
- /*
+ /**
* @brief Calculate 8 bit 2's complement checksum
*
* Initialize checksum to 0. For each byte, checksum = (checksum + byte)