Add documentation headers across system modules

Trenser.VehicleServiceSystem/Trenser.VehicleServiceSystem/services/InventoryManagementService.cpp

@@ -1,9 +1,28 @@
+/*
+File: InventoryManagementService.cpp
+Description: Implements the InventoryManagementService class, which manages inventory
+			 items and observer relationships within the system. Provides methods
+			 for loading and saving inventory items from persistent storage, as well
+			 as attaching and persisting observers for notification handling.
+Author: Trenser
+Date: 22-May-2026
+*/
+
 #include "InventoryManagementService.h"
 #include "FileManager.h"
 #include "InventoryItem.h"
 #include "Utility.h"
 #include "Config.h"
 
+/*
+Function: getObserverIDs
+Description: Retrieves the IDs of all observers currently attached to the
+			 InventoryManagementService.
+Parameters:
+	- None
+Returns:
+	- util::Vector<std::string>: Vector of observer user IDs
+*/
 util::Vector<std::string> InventoryManagementService::getObserverIDs()
 {
 	util::Vector<std::string> observerIDs;
@@ -19,6 +38,15 @@ util::Vector<std::string> InventoryManagementService::getObserverIDs()
 	return observerIDs;
 }
 
+/*
+Function: loadInventoryItems
+Description: Loads inventory items from persistent storage into the datastore.
+			 Uses FileManager to deserialize inventory items from the configured file.
+Parameters:
+	- None
+Returns:
+	- void
+*/
 void InventoryManagementService::loadInventoryItems()
 {
 	util::FileManager<InventoryItem> inventoryItemFileManager(config::file::INVENTORYITEM_FILE);
@@ -31,6 +59,15 @@ void InventoryManagementService::loadInventoryItems()
 	}
 }
 
+/*
+Function: saveInventoryItems
+Description: Saves inventory items from the datastore to persistent storage.
+			 Uses FileManager to serialize inventory items into the configured file.
+Parameters:
+	- None
+Returns:
+	- void
+*/
 void InventoryManagementService::saveInventoryItems()
 {
 	util::FileManager<InventoryItem> inventoryItemFileManager(config::file::INVENTORYITEM_FILE);
@@ -38,12 +75,30 @@ void InventoryManagementService::saveInventoryItems()
 	inventoryItemFileManager.save(inventoryItems);
 }
 
+/*
+Function: loadObservers
+Description: Loads observer IDs from persistent storage and attaches corresponding
+			 users as observers to the InventoryManagementService.
+Parameters:
+	- None
+Returns:
+	- void
+*/
 void InventoryManagementService::loadObservers()
 {
 	util::loadObservers(config::file::INVENTORYMANAGEMENTOBSERVERS, this, m_dataStore);
 }
 
+/*
+Function: saveObservers
+Description: Saves the current observer IDs of the InventoryManagementService
+			 to persistent storage for future retrieval.
+Parameters:
+	- None
+Returns:
+	- void
+*/
 void InventoryManagementService::saveObservers()
 {
 	util::saveObservers(config::file::INVENTORYMANAGEMENTOBSERVERS, this);
-}
+}

Trenser.VehicleServiceSystem/Trenser.VehicleServiceSystem/services/PaymentManagementService.cpp

@@ -5,6 +5,15 @@
 #include "Utility.h"
 #include "Config.h"
 
+/*
+Function: getObserverIDs
+Description: Retrieves the IDs of all observers currently attached to the
+             PaymentManagementService.
+Parameters:
+    - None
+Returns:
+    - util::Vector<std::string>: Vector of observer user IDs
+*/
 util::Vector<std::string> PaymentManagementService::getObserverIDs()
 {
 	util::Vector<std::string> observerIDs;
@@ -20,6 +29,19 @@ util::Vector<std::string> PaymentManagementService::getObserverIDs()
 	return observerIDs;
 }
 
+/*
+Function: loadInvoices
+Description: Loads invoices from persistent storage into the datastore.
+             Validates associated service bookings and inventory parts before
+             attaching them to each invoice. Throws exceptions if invalid IDs
+             are encountered.
+Parameters:
+    - None
+Returns:
+    - void
+Throws:
+    - std::runtime_error if a booking ID or part ID is invalid
+*/
 void PaymentManagementService::loadInvoices()
 {
     util::FileManager<Invoice> invoiceFileManager(config::file::INVOICE_FILE);
@@ -53,6 +75,16 @@ void PaymentManagementService::loadInvoices()
         invoices[invoice->getId()] = invoice;
     }
 }
+
+/*
+Function: saveInvoices
+Description: Saves invoices from the datastore to persistent storage.
+             Uses FileManager to serialize invoices into the configured file.
+Parameters:
+    - None
+Returns:
+    - void
+*/
 void PaymentManagementService::saveInvoices()
 {
     util::FileManager<Invoice> invoiceFileManager(config::file::INVOICE_FILE);
@@ -60,12 +92,32 @@ void PaymentManagementService::saveInvoices()
     invoiceFileManager.save(invoices);
 }
 
+/*
+Function: loadObservers
+Description: Loads observer IDs from persistent storage and attaches corresponding
+             users as observers to the PaymentManagementService.
+Parameters:
+    - None
+Returns:
+    - void
+Throws:
+    - std::runtime_error if an observer ID is invalid (not found in datastore)
+*/
 void PaymentManagementService::loadObservers()
 {
     util::loadObservers(config::file::PAYMENTMANAGEMENTOBSERVERS, this, m_dataStore);
 }
 
+/*
+Function: saveObservers
+Description: Saves the current observer IDs of the PaymentManagementService
+             to persistent storage for future retrieval.
+Parameters:
+    - None
+Returns:
+    - void
+*/
 void PaymentManagementService::saveObservers()
 {
     util::saveObservers(config::file::PAYMENTMANAGEMENTOBSERVERS, this);
-}
+}

Trenser.VehicleServiceSystem/Trenser.VehicleServiceSystem/services/ServiceManagementService.cpp

@@ -8,6 +8,15 @@
 #include "Config.h"
 #include "Utility.h"
 
+/*
+Function: getObserverIDs
+Description: Retrieves the IDs of all observers currently attached to the
+             ServiceManagementService.
+Parameters:
+    - None
+Returns:
+    - util::Vector<std::string>: Vector of observer user IDs
+*/
 util::Vector<std::string> ServiceManagementService::getObserverIDs()
 {
 	util::Vector<std::string> observerIDs;
@@ -23,6 +32,17 @@ util::Vector<std::string> ServiceManagementService::getObserverIDs()
 	return observerIDs;
 }
 
+/*
+Function: loadServices
+Description: Loads services from persistent storage into the datastore.
+             Validates required inventory items and attaches them to each service.
+Parameters:
+    - None
+Returns:
+    - void
+Throws:
+    - std::runtime_error if an inventory item ID is invalid
+*/
 void ServiceManagementService::loadServices()
 {
     util::FileManager<Service> serviceFileManager(config::file::SERVICE_FILE);
@@ -49,6 +69,15 @@ void ServiceManagementService::loadServices()
     }
 }
 
+/*
+Function: saveServices
+Description: Saves services from the datastore to persistent storage.
+             Uses FileManager to serialize services into the configured file.
+Parameters:
+    - None
+Returns:
+    - void
+*/
 void ServiceManagementService::saveServices()
 {
 	util::FileManager<Service> serviceFileManager(config::file::SERVICE_FILE);
@@ -56,6 +85,17 @@ void ServiceManagementService::saveServices()
 	serviceFileManager.save(services);
 }
 
+/*
+Function: loadComboPackages
+Description: Loads combo packages from persistent storage into the datastore.
+             Validates associated services and attaches them to each package.
+Parameters:
+    - None
+Returns:
+    - void
+Throws:
+    - std::runtime_error if a service ID is invalid
+*/
 void ServiceManagementService::loadComboPackages()
 {
     util::FileManager<ComboPackage> comboPackageFileManager(config::file::COMBOPACKAGE_FILE);
@@ -82,6 +122,15 @@ void ServiceManagementService::loadComboPackages()
     }
 }
 
+/*
+Function: saveComboPackages
+Description: Saves combo packages from the datastore to persistent storage.
+             Uses FileManager to serialize combo packages into the configured file.
+Parameters:
+    - None
+Returns:
+    - void
+*/
 void ServiceManagementService::saveComboPackages()
 {
     util::FileManager<ComboPackage> comboPackageFileManager(config::file::COMBOPACKAGE_FILE);
@@ -89,6 +138,19 @@ void ServiceManagementService::saveComboPackages()
     comboPackageFileManager.save(comboPackages);
 }
 
+/*
+Function: loadServiceBookings
+Description: Loads service bookings from persistent storage into the datastore.
+             Validates associated services, customers, and technicians before
+             attaching them to each booking.
+Parameters:
+    - None
+Returns:
+    - void
+Throws:
+    - std::runtime_error if a service ID, customer ID, or technician ID is invalid
+    - std::runtime_error if a user is not of the expected type (customer/technician)
+*/
 void ServiceManagementService::loadServiceBookings()
 {
     util::FileManager<ServiceBooking> bookingFileManager(config::file::SERVICEBOOKING_FILE);
@@ -143,6 +205,15 @@ void ServiceManagementService::loadServiceBookings()
     }
 }
 
+/*
+Function: saveServiceBookings
+Description: Saves service bookings from the datastore to persistent storage.
+             Uses FileManager to serialize bookings into the configured file.
+Parameters:
+    - None
+Returns:
+    - void
+*/
 void ServiceManagementService::saveServiceBookings()
 {
     util::FileManager<ServiceBooking> bookingFileManager(config::file::SERVICEBOOKING_FILE);
@@ -150,6 +221,20 @@ void ServiceManagementService::saveServiceBookings()
     bookingFileManager.save(serviceBookings);
 }
 
+/*
+Function: loadJobCards
+Description: Loads job cards from persistent storage into the datastore.
+             Validates associated bookings, services, and technicians before
+             attaching them to each job card.
+Parameters:
+    - None
+Returns:
+    - void
+Throws:
+    - std::runtime_error if a booking ID, service ID, or technician ID is invalid
+    - std::runtime_error if a service does not belong to the booking
+    - std::runtime_error if a user is not a technician
+*/
 void ServiceManagementService::loadJobCards()
 {
     util::FileManager<JobCard> jobCardFileManager(config::file::JOBCARD_FILE);
@@ -193,6 +278,16 @@ void ServiceManagementService::loadJobCards()
         jobCards[jobCard->getId()] = jobCard;
     }
 }
+
+/*
+Function: saveJobCards
+Description: Saves job cards from the datastore to persistent storage.
+             Uses FileManager to serialize job cards into the configured file.
+Parameters:
+    - None
+Returns:
+    - void
+*/
 void ServiceManagementService::saveJobCards()
 {
     util::FileManager<JobCard> jobCardFileManager(config::file::JOBCARD_FILE);
@@ -200,12 +295,32 @@ void ServiceManagementService::saveJobCards()
     jobCardFileManager.save(jobCards);
 }
 
+/*
+Function: loadObservers
+Description: Loads observer IDs from persistent storage and attaches corresponding
+             users as observers to the ServiceManagementService.
+Parameters:
+    - None
+Returns:
+    - void
+Throws:
+    - std::runtime_error if an observer ID is invalid (not found in datastore)
+*/
 void ServiceManagementService::loadObservers()
 {
     util::loadObservers(config::file::SERVICEMANAGEMENTOBSERVERS, this, m_dataStore);
 }
 
+/*
+Function: saveObservers
+Description: Saves the current observer IDs of the ServiceManagementService
+             to persistent storage for future retrieval.
+Parameters:
+    - None
+Returns:
+    - void
+*/
 void ServiceManagementService::saveObservers()
 {
     util::saveObservers(config::file::SERVICEMANAGEMENTOBSERVERS, this);
-}
+}

Trenser.VehicleServiceSystem/Trenser.VehicleServiceSystem/services/UserManagementService.cpp

@@ -4,6 +4,18 @@
 #include "Notification.h"
 #include "Config.h"
 
+/*
+Function: loadUsers
+Description: Loads users and notifications from persistent storage into the datastore.
+             Validates that each notification’s recipient exists and attaches the
+             notification to the corresponding user.
+Parameters:
+    - None
+Returns:
+    - void
+Throws:
+    - std::runtime_error if a notification recipient user ID is invalid
+*/
 void UserManagementService::loadUsers()
 {
     util::FileManager<User> userFileManager(config::file::USER_FILE);
@@ -31,6 +43,15 @@ void UserManagementService::loadUsers()
     }
 }
 
+/*
+Function: saveUsers
+Description: Saves users and their notifications from the datastore to persistent storage.
+             Collects notifications from all users into a single map before saving.
+Parameters:
+    - None
+Returns:
+    - void
+*/
 void UserManagementService::saveUsers()
 {
     util::FileManager<User> userFileManager(config::file::USER_FILE);
@@ -49,4 +70,4 @@ void UserManagementService::saveUsers()
     }
     userFileManager.save(users);
     notificationFileManager.save(notifications);
-}
+}