From 6e1ba9effa687791170858cf10aa1c26c0742b75 Mon Sep 17 00:00:00 2001 From: Richard Marian Thomaiyar Date: Thu, 29 Nov 2018 06:29:21 +0530 Subject: 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 --- user_channel/usercommands.hpp | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) (limited to 'user_channel/usercommands.hpp') 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, -- cgit v1.2.1