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/integrity_algo.hpp b/integrity_algo.hpp
index 7b895c5..eb78578 100644
--- a/integrity_algo.hpp
+++ b/integrity_algo.hpp
@@ -30,7 +30,7 @@
0x01, 0x01, 0x01, 0x01, 0x01
};
-/*
+/**
* @enum Integrity Algorithms
*
* The Integrity Algorithm Number specifies the algorithm used to generate the
@@ -48,7 +48,7 @@
HMAC_SHA256_128, // Optional
};
-/*
+/**
* @class Interface
*
* Interface is the base class for the Integrity Algorithms.
@@ -59,7 +59,7 @@
class Interface
{
public:
- /*
+ /**
* @brief Constructor for Interface
*
* @param[in] - Session Integrity Key to generate K1
@@ -77,7 +77,7 @@
Interface(Interface&&) = default;
Interface& operator=(Interface&&) = default;
- /*
+ /**
* @brief Verify the integrity data of the packet
*
* @param[in] packet - Incoming IPMI packet
@@ -92,7 +92,7 @@
const size_t packetLen,
Buffer::const_iterator integrityData) const = 0;
- /*
+ /**
* @brief Generate integrity data for the outgoing IPMI packet
*
* @param[in] input - Outgoing IPMI packet
@@ -122,20 +122,21 @@
}
}
- /*
- * AuthCode field length varies based on the integrity algorithm, for
- * HMAC-SHA1-96 the authcode field is 12 bytes. For HMAC-SHA256-128 and
- * HMAC-MD5-128 the authcode field is 16 bytes.
+ /** @brief Authcode field
+ *
+ * AuthCode field length varies based on the integrity algorithm, for
+ * HMAC-SHA1-96 the authcode field is 12 bytes. For HMAC-SHA256-128 and
+ * HMAC-MD5-128 the authcode field is 16 bytes.
*/
size_t authCodeLength;
protected:
- // K1 key used to generated the integrity data
+ /** @brief K1 key used to generated the integrity data. */
Key K1;
};
-/*
+/**
* @class AlgoSHA1
*
* @brief Implementation of the HMAC-SHA1-96 Integrity algorithm
@@ -151,7 +152,7 @@
public:
static constexpr size_t SHA1_96_AUTHCODE_LENGTH = 12;
- /*
+ /**
* @brief Constructor for AlgoSHA1
*
* @param[in] - Session Integrity Key
@@ -166,7 +167,7 @@
AlgoSHA1(AlgoSHA1&&) = default;
AlgoSHA1& operator=(AlgoSHA1&&) = default;
- /*
+ /**
* @brief Verify the integrity data of the packet
*
* @param[in] packet - Incoming IPMI packet
@@ -182,7 +183,7 @@
const size_t length,
Buffer::const_iterator integrityData) const override;
- /*
+ /**
* @brief Generate integrity data for the outgoing IPMI packet
*
* @param[in] input - Outgoing IPMI packet
@@ -193,7 +194,7 @@
Buffer generateIntegrityData(const Buffer& packet) const override;
private:
- /*
+ /**
* @brief Generate HMAC based on HMAC-SHA1-96 algorithm
*
* @param[in] input - pointer to the message