Add documentation headers across system modules

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

@@ -9,6 +9,15 @@
 #include "JobCard.h"
 #include "Enums.h"
 
+/*
+Function: createInventoryItemsMap (static helper)
+Description: Builds a map of inventory items required for a given service and adds them to the booking’s inventory map.
+Parameters:
+	- completeInventoryItemMapOfBooking: util::Map<std::string, InventoryItem*>&, map to store inventory items for the booking
+	- currentService: const Service*, pointer to the current service
+Returns:
+	- void
+*/
 static void createInventoryItemsMap(util::Map<std::string, InventoryItem*>& completeInventoryItemMapOfBooking, const Service* currentService)
 {
 	auto& currentRequiredInventoryItems = currentService->getRequiredInventoryItems();
@@ -19,6 +28,18 @@ static void createInventoryItemsMap(util::Map<std::string, InventoryItem*>& comp
 	}
 }
 
+/*
+Function: generateInvoice
+Description: Generates an invoice for a completed service booking.
+			 Validates that all job cards are completed, calculates labor and parts cost, applies discount,
+			 and stores the invoice in the datastore.
+Parameters:
+	- booking: ServiceBooking*, pointer to the service booking
+Returns:
+	- void
+Throws:
+	- std::runtime_error if booking is null or job cards are incomplete
+*/
 void PaymentManagementService::generateInvoice(ServiceBooking* booking)
 {
 	if (!booking)
@@ -56,6 +77,14 @@ void PaymentManagementService::generateInvoice(ServiceBooking* booking)
 	currentInvoices.insert(invoice->getId(), invoice);
 }
 
+/*
+Function: getInvoices
+Description: Retrieves all invoices associated with a specific customer.
+Parameters:
+	- customerID: std::string, ID of the customer
+Returns:
+	- util::Map<std::string, Invoice*> containing the customer’s invoices
+*/
 util::Map<std::string, Invoice*> PaymentManagementService::getInvoices(const std::string& customerID)
 {
 	util::Map<std::string, Invoice*>& currentInvoices = m_dataStore.getInvoices();
@@ -71,6 +100,18 @@ util::Map<std::string, Invoice*> PaymentManagementService::getInvoices(const std
 	return currentUserInvoices;
 }
 
+/*
+Function: completePayment
+Description: Completes payment for a specific invoice. Updates payment method, date, and status,
+			 then sends a notification to the customer.
+Parameters:
+	- invoiceID: std::string, ID of the invoice
+	- paymentMode: util::PaymentMode, mode of payment (e.g., ONLINE, OFFLINE)
+Returns:
+	- void
+Throws:
+	- std::runtime_error if the invoice ID is invalid
+*/
 void PaymentManagementService::completePayment(const std::string& invoiceID, util::PaymentMode paymentMode)
 {
 	auto& currentInvoices = m_dataStore.getInvoices();