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/command/channel_auth.hpp b/command/channel_auth.hpp
index 7b922c2..9d96ac0 100644
--- a/command/channel_auth.hpp
+++ b/command/channel_auth.hpp
@@ -7,8 +7,8 @@
namespace command
{
-/*
- * @ struct GetChannelCapabilitiesReq
+/**
+ * @struct GetChannelCapabilitiesReq
*
* IPMI Request data for Get Channel Authentication Capabilities command
*/
@@ -18,8 +18,8 @@
uint8_t reqMaxPrivLevel;
} __attribute__((packed));
-/*
- * @ struct GetChannelCapabilitiesResp
+/**
+ * @struct GetChannelCapabilitiesResp
*
* IPMI Response data for Get Channel Authentication Capabilities command
*/
@@ -101,7 +101,7 @@
uint8_t oemAuxillary; // Addition OEM specific information..
} __attribute__((packed));
-/*
+/**
* @brief Get Channel Authentication Capabilities
*
* This message exchange provides a way for a remote console to discover what
diff --git a/command/guid.hpp b/command/guid.hpp
index 03c6272..622b330 100644
--- a/command/guid.hpp
+++ b/command/guid.hpp
@@ -10,7 +10,7 @@
constexpr size_t BMC_GUID_LEN = 16;
-/*
+/**
* @brief Get System GUID
*
* @return If UUID is successfully read from the Chassis DBUS object, then the
diff --git a/command/open_session.hpp b/command/open_session.hpp
index 717b99b..677fe55 100644
--- a/command/open_session.hpp
+++ b/command/open_session.hpp
@@ -7,8 +7,8 @@
namespace command
{
-/*
- * @ struct OpenSessionRequest
+/**
+ * @struct OpenSessionRequest
*
* IPMI Payload for RMCP+ Open Session Request
*/
@@ -82,8 +82,8 @@
uint16_t reserved14;
} __attribute__((packed));
-/*
- * @ struct OpenSessionResponse
+/**
+ * @struct OpenSessionResponse
*
* IPMI Payload for RMCP+ Open Session Response
*/
@@ -159,7 +159,7 @@
uint16_t reserved14;
} __attribute__((packed));
-/*
+/**
* @brief RMCP+ Open Session Request, RMCP+ Open Session Response
*
* The RMCP+ Open Session request and response messages are used to enable a
diff --git a/command/rakp12.hpp b/command/rakp12.hpp
index 2d86bdb..fb9a499 100644
--- a/command/rakp12.hpp
+++ b/command/rakp12.hpp
@@ -8,7 +8,7 @@
namespace command
{
-/*
+/**
* @struct RAKP1request
*
* IPMI Payload for RAKP Message 1
@@ -26,7 +26,7 @@
char user_name[16];
} __attribute__((packed));
-/*
+/**
* @struct RAKP2response
*
* IPMI Payload for RAKP Message 2
@@ -41,7 +41,7 @@
uint8_t managed_system_guid[16];
} __attribute__((packed));
-/*
+/**
* @brief RAKP Message 1, RAKP Message 2
*
* These messages are used to exchange random number and identification
diff --git a/command/rakp34.hpp b/command/rakp34.hpp
index a110a24..deaf2e9 100644
--- a/command/rakp34.hpp
+++ b/command/rakp34.hpp
@@ -8,7 +8,7 @@
namespace command
{
-/*
+/**
* @struct RAKP3request
*
* IPMI Payload for RAKP Message 3
@@ -22,7 +22,7 @@
uint8_t keyExchangeAuthCode[20];
} __attribute__((packed));
-/*
+/**
* @struct RAKP4response
*
* IPMI Payload for RAKP Message 4
@@ -35,7 +35,7 @@
uint32_t remoteConsoleSessionID;
} __attribute__((packed));
-/*
+/**
* @brief RAKP Message 3, RAKP Message 4
*
* The session activation process is completed by the remote console and BMC
diff --git a/command/session_cmds.hpp b/command/session_cmds.hpp
index 95e3464..738bd03 100644
--- a/command/session_cmds.hpp
+++ b/command/session_cmds.hpp
@@ -10,8 +10,8 @@
constexpr uint8_t IPMI_CC_INVALID_PRIV_LEVEL = 0x80;
constexpr uint8_t IPMI_CC_EXCEEDS_USER_PRIV = 0x81;
-/*
- * @ struct SetSessionPrivLevelReq
+/**
+ * @struct SetSessionPrivLevelReq
*
* IPMI Request data for Set Session Privilege Level command
*/
@@ -30,8 +30,8 @@
} __attribute__((packed));
-/*
- * @ struct SetSessionPrivLevelResp
+/**
+ * @struct SetSessionPrivLevelResp
*
* IPMI Response data for Set Session Privilege Level command
*/
@@ -51,7 +51,7 @@
} __attribute__((packed));
-/*
+/**
* @brief Set Session Privilege Command
*
* This command is sent in authenticated format. When a session is activated,
@@ -76,8 +76,8 @@
constexpr uint8_t IPMI_CC_INVALID_SESSIONID = 0x87;
-/*
- * @ struct CloseSessionRequest
+/**
+ * @struct CloseSessionRequest
*
* IPMI Request data for Close Session command
*/
@@ -87,8 +87,8 @@
uint8_t sessionHandle;
} __attribute__((packed));
-/*
- * @ struct CloseSessionResponse
+/**
+ * @struct CloseSessionResponse
*
* IPMI Response data for Close Session command
*/
@@ -97,7 +97,7 @@
uint8_t completionCode;
} __attribute__((packed));
-/*
+/**
* @brief Close Session Command
*
* This command is used to immediately terminate a session in progress. It is