commit 6e1ba9effa687791170858cf10aa1c26c0742b75
author Richard Marian Thomaiyar <richard.marian.thomaiyar@linux.intel.com> Thu Nov 29 06:29:21 2018 +0530
committer Richard Marian Thomaiyar <richard.marian.thomaiyar@linux.intel.com> Wed Dec 19 01:11:45 2018 +0000
tree 916ac96453a1a8e4d791bb43e3393eadc8a5c8ac
parent 43cb12895039d972e640b992bacf9c13146876ee

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>

user_channel/channel_mgmt.hpp

diff --git a/user_channel/channel_mgmt.hpp b/user_channel/channel_mgmt.hpp
index 09d2a71..8cdb9c7 100644
--- a/user_channel/channel_mgmt.hpp
+++ b/user_channel/channel_mgmt.hpp
@@ -38,12 +38,22 @@
 static constexpr const char* ipmiChMutexCleanupLockFile =
     "/var/lib/ipmi/ipmi_channel_mutex_cleanup";
 
+/** @struct ChannelAccessData
+ *
+ *  Structure to store both non-volatile and volatile channel access information
+ *  as used by IPMI specification (refer spec sec 22.22 to 22.24)
+ */
 struct ChannelAccessData
 {
     ChannelAccess chNonVolatileData;
     ChannelAccess chVolatileData;
 };
 
+/** @struct ChannelData
+ *
+ *  Structure for channel information - base structure to get all information
+ * about the channel.(refer spec sec 22.22 to 22.24)
+ */
 struct ChannelData
 {
     std::string chName;