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/usercommands.hpp | |
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/usercommands.hpp')
-rw-r--r-- | user_channel/usercommands.hpp | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/user_channel/usercommands.hpp b/user_channel/usercommands.hpp index afbe67a..ea04a26 100644 --- a/user_channel/usercommands.hpp +++ b/user_channel/usercommands.hpp @@ -19,7 +19,10 @@ namespace ipmi { -// IPMI commands for user command NETFN:APP. + +/** + * @enum IPMI commands for user command NETFN:APP. + */ enum ipmi_netfn_user_cmds { IPMI_CMD_SET_USER_ACCESS = 0x43, @@ -29,6 +32,9 @@ enum ipmi_netfn_user_cmds IPMI_CMD_SET_USER_PASSWORD = 0x47, }; +/** + * @enum IPMI set password return codes (refer spec sec 22.30) + */ enum class IPMISetPasswordReturnCodes { ipmiCCPasswdFailMismatch = 0x80, |