Doxygen comments for enum & structure
Added doxygen comments for enums & structures for user & channel
layers.
Unit-test:
verified build.
Change-Id: Ie5af8d6cdd4c04cb396869b7a3dc44f84efedd19
Signed-off-by: Richard Marian Thomaiyar <richard.marian.thomaiyar@linux.intel.com>
diff --git a/user_channel/channelcommands.cpp b/user_channel/channelcommands.cpp
index c5ef8b7..865d764 100644
--- a/user_channel/channelcommands.cpp
+++ b/user_channel/channelcommands.cpp
@@ -27,6 +27,10 @@
namespace ipmi
{
+/** @struct setChannelAccessReq
+ *
+ * Structure for set channel access request command (refer spec sec 22.22)
+ */
struct setChannelAccessReq
{
#if BYTE_ORDER == LITTLE_ENDIAN
@@ -56,6 +60,10 @@
} __attribute__((packed));
+/** @struct getChannelAccessReq
+ *
+ * Structure for get channel access request command (refer spec sec 22.23)
+ */
struct getChannelAccessReq
{
#if BYTE_ORDER == LITTLE_ENDIAN
@@ -72,6 +80,10 @@
#endif
} __attribute__((packed));
+/** @struct getChannelAccessResp
+ *
+ * Structure for get channel access response command (refer spec sec 22.23)
+ */
struct getChannelAccessResp
{
#if BYTE_ORDER == LITTLE_ENDIAN
@@ -94,6 +106,10 @@
#endif
} __attribute__((packed));
+/** @struct getChannelInfoReq
+ *
+ * Structure for get channel info request command (refer spec sec 22.24)
+ */
struct getChannelInfoReq
{
#if BYTE_ORDER == LITTLE_ENDIAN
@@ -106,6 +122,10 @@
#endif
} __attribute__((packed));
+/** @struct getChannelInfoResp
+ *
+ * Structure for get channel info response command (refer spec sec 22.24)
+ */
struct getChannelInfoResp
{
#if BYTE_ORDER == LITTLE_ENDIAN