Add standardized documentation headers
This commit is contained in:
+25
@@ -1,11 +1,30 @@
|
||||
/*
|
||||
File: UserManagementService.cpp
|
||||
Description: Implementation file containing the method definitions of the
|
||||
UserManagementService class, including user retrieval and removal logic.
|
||||
Author: Trenser
|
||||
Date:19-May-2026
|
||||
*/
|
||||
#include "UserManagementService.h"
|
||||
#include "User.h"
|
||||
|
||||
/*
|
||||
Function: getUsers
|
||||
Description: Retrieves all users stored in the DataStore.
|
||||
Parameter: None
|
||||
Return type: util::Map<std::string, User*>
|
||||
*/
|
||||
util::Map<std::string, User*> UserManagementService::getUsers()
|
||||
{
|
||||
return m_dataStore.getUsers();
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getUser
|
||||
Description: Retrieves a specific user by ID from the DataStore.
|
||||
Parameter: const std::string& userID - ID of the user
|
||||
Return type: User*
|
||||
*/
|
||||
User* UserManagementService::getUser(const std::string& userID)
|
||||
{
|
||||
int index = m_dataStore.getUsers().find(userID);
|
||||
@@ -16,6 +35,12 @@ User* UserManagementService::getUser(const std::string& userID)
|
||||
return nullptr;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: removeUser
|
||||
Description: Marks a user as inactive in the DataStore instead of deleting them.
|
||||
Parameter: const std::string& userID - ID of the user to remove
|
||||
Return type: void
|
||||
*/
|
||||
void UserManagementService::removeUser(const std::string& userID)
|
||||
{
|
||||
int index = m_dataStore.getUsers().find(userID);
|
||||
|
||||
Reference in New Issue
Block a user