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/auth_algo.hpp b/auth_algo.hpp
index c0663b1..cf5ccfe 100644
--- a/auth_algo.hpp
+++ b/auth_algo.hpp
@@ -14,7 +14,7 @@
constexpr size_t BMC_RANDOM_NUMBER_LEN = 16;
constexpr size_t REMOTE_CONSOLE_RANDOM_NUMBER_LEN = 16;
-/*
+/**
* @enum RAKP Authentication Algorithms
*
* RMCP+ Authenticated Key-Exchange Protocol (RAKP)
@@ -35,7 +35,7 @@
RAKP_HMAC_INVALID = 0xB0
};
-/*
+/**
* @class Interface
*
* Interface is the base class for the Authentication Algorithms.
@@ -59,7 +59,7 @@
Interface(Interface&&) = default;
Interface& operator=(Interface&&) = default;
- /*
+ /**
* @brief Generate the Hash Message Authentication Code
*
* This API is invoked to generate the Key Exchange Authentication Code
@@ -76,7 +76,7 @@
std::vector<uint8_t> virtual generateHMAC(
std::vector<uint8_t>& input) const = 0;
- /*
+ /**
* @brief Generate the Integrity Check Value
*
* This API is invoked in the RAKP4 sequence for generating the
@@ -105,7 +105,7 @@
// Session Integrity Key
std::vector<uint8_t> sessionIntegrityKey;
- /*
+ /**
* Integrity Algorithm is activated and set in the session data only
* once the session setup is succeeded in the RAKP34 command. But the
* integrity algorithm is negotiated in the Open Session Request command
@@ -114,7 +114,7 @@
*/
integrity::Algorithms intAlgo;
- /*
+ /**
* Confidentiality Algorithm is activated and set in the session data
* only once the session setup is succeeded in the RAKP34 command. But
* the confidentiality algorithm is negotiated in the Open Session
@@ -124,7 +124,7 @@
crypt::Algorithms cryptAlgo;
};
-/*
+/**
* @class AlgoSHA1
*
* RAKP-HMAC-SHA1 specifies the use of RAKP messages for the key exchange