commit 3563f8fe152954aeab40e8581d8de729d834dbea
author Tom Joseph <tomjoseph@in.ibm.com> Mon May 08 15:42:54 2017 +0530
committer Tom Joseph <tomjoseph@in.ibm.com> Tue May 23 15:25:51 2017 +0530
tree 04c08c8954fdf0862b1ed046557eb3a3b7264115
parent 15771d1857a81b60e26475ab2f2f732bd4f058f3

Correct doxygen syntax in phosphor-net-ipmid

Resolves openbmc/openbmc#1147

Change-Id: I57ab1b09ec1bf308cc3d97cd30b2d18564beb38b
Signed-off-by: Tom Joseph <tomjoseph@in.ibm.com>

message_parsers.hpp

diff --git a/message_parsers.hpp b/message_parsers.hpp
index fc82abc..e55e405 100644
--- a/message_parsers.hpp
+++ b/message_parsers.hpp
@@ -49,7 +49,7 @@
     } format;
 } __attribute__((packed));
 
-/*
+/**
  * @brief Unflatten an incoming packet and prepare the IPMI message
  *
  * @param[in] inPacket - Incoming IPMI packet
@@ -62,7 +62,7 @@
 std::tuple<std::unique_ptr<Message>, SessionHeader> unflatten(
         std::vector<uint8_t>& inPacket);
 
-/*
+/**
  * @brief Flatten an IPMI message and generate the IPMI packet with the
  *        session header
  *
@@ -95,7 +95,7 @@
     uint8_t legacyPad;
 } __attribute__((packed));
 
-/*
+/**
  * @brief Unflatten an incoming packet and prepare the IPMI message
  *
  * @param[in] inPacket - Incoming IPMI packet
@@ -104,7 +104,7 @@
  */
 std::unique_ptr<Message> unflatten(std::vector<uint8_t>& inPacket);
 
-/*
+/**
  * @brief Flatten an IPMI message and generate the IPMI packet with the
  *        session header
  *
@@ -141,7 +141,7 @@
     uint8_t nextHeader;
 } __attribute__((packed));
 
-/*
+/**
  * @brief Unflatten an incoming packet and prepare the IPMI message
  *
  * @param[in] inPacket - Incoming IPMI packet
@@ -150,7 +150,7 @@
  */
 std::unique_ptr<Message> unflatten(std::vector<uint8_t>& inPacket);
 
-/*
+/**
  * @brief Flatten an IPMI message and generate the IPMI packet with the
  *        session header
  *
@@ -163,7 +163,7 @@
 namespace internal
 {
 
-/*
+/**
  * @brief Add sequence number to the message
  *
  * @param[in] packet - outgoing packet to which to add sequence number
@@ -172,7 +172,7 @@
  */
 void addSequenceNumber(std::vector<uint8_t>& packet, session::Session& session);
 
-/*
+/**
  * @brief Verify the integrity data of the incoming IPMI packet
  *
  * @param[in] packet - Incoming IPMI packet
@@ -184,7 +184,7 @@
                            const Message& message,
                            size_t payloadLen);
 
-/*
+/**
  * @brief Add Integrity data to the outgoing IPMI packet
  *
  * @param[in] packet - Outgoing IPMI packet
@@ -195,7 +195,7 @@
                       const Message& message,
                       size_t payloadLen);
 
-/*
+/**
  * @brief Decrypt the encrypted payload in the incoming IPMI packet
  *
  * @param[in] packet - Incoming IPMI packet
@@ -208,7 +208,7 @@
                                     const Message& message,
                                     size_t payloadLen);
 
-/*
+/**
  * @brief Encrypt the plain text payload for the outgoing IPMI packet
  *
  * @param[in] message - IPMI Message populated for the outgoing packet