diff options
| author | Richard Marian Thomaiyar <richard.marian.thomaiyar@linux.intel.com> | 2018-11-29 06:29:21 +0530 |
|---|---|---|
| committer | Richard Marian Thomaiyar <richard.marian.thomaiyar@linux.intel.com> | 2018-12-19 01:11:45 +0000 |
| commit | 6e1ba9effa687791170858cf10aa1c26c0742b75 (patch) | |
| tree | 916ac96453a1a8e4d791bb43e3393eadc8a5c8ac /user_channel/channelcommands.cpp | |
| parent | 43cb12895039d972e640b992bacf9c13146876ee (diff) | |
| download | phosphor-host-ipmid-6e1ba9effa687791170858cf10aa1c26c0742b75.tar.gz phosphor-host-ipmid-6e1ba9effa687791170858cf10aa1c26c0742b75.zip | |
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>
Diffstat (limited to 'user_channel/channelcommands.cpp')
| -rw-r--r-- | user_channel/channelcommands.cpp | 20 |
1 files changed, 20 insertions, 0 deletions
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 @@ using namespace phosphor::logging; 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 @@ struct setChannelAccessReq } __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 @@ struct getChannelAccessReq #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 @@ struct getChannelAccessResp #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 @@ struct getChannelInfoReq #endif } __attribute__((packed)); +/** @struct getChannelInfoResp + * + * Structure for get channel info response command (refer spec sec 22.24) + */ struct getChannelInfoResp { #if BYTE_ORDER == LITTLE_ENDIAN |
