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/user_mgmt.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/user_mgmt.hpp')
| -rw-r--r-- | user_channel/user_mgmt.hpp | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/user_channel/user_mgmt.hpp b/user_channel/user_mgmt.hpp index a54486f..0326dca 100644 --- a/user_channel/user_mgmt.hpp +++ b/user_channel/user_mgmt.hpp @@ -37,6 +37,9 @@ using DbusUserObjProperties = using DbusUserObjValue = std::map<std::string, DbusUserObjProperties>; +/** + * @enum User update events. + */ enum class UserUpdateEvent { reservedEvent, @@ -48,6 +51,10 @@ enum class UserUpdateEvent userStateUpdated }; +/** @struct UserPrivAccess + * + * Structure for user privilege access (refer spec sec 22.22) + */ struct UserPrivAccess { uint8_t privilege; @@ -56,6 +63,10 @@ struct UserPrivAccess bool accessCallback; }; +/** @struct UserInfo + * + * Structure for user related information + */ struct UserInfo { uint8_t userName[ipmiMaxUserName]; @@ -65,6 +76,10 @@ struct UserInfo bool fixedUserName; }; +/** @struct UsersTbl + * + * Structure for array of user related information + */ struct UsersTbl { //+1 to map with UserId directly. UserId 0 is reserved. |
