Add documentation headers across system modules

Trenser.VehicleServiceSystem/Trenser.VehicleServiceSystem/views/AdminMenu.cpp

@@ -62,6 +62,16 @@ void AdminMenu::checkStockAvailability()
 {
 }
 
+/*
+Function: listServiceBookings (static helper)
+Description: Lists all pending service bookings and maps them to indices for selection.
+Parameters:
+	- currentBookings: util::Map<std::string, const ServiceBooking*>&, current bookings
+	- bookingsSize: int&, number of bookings
+	- serviceBookingsMap: util::Map<int, const ServiceBooking*>&, map of indexed bookings
+Returns:
+	- bool: True if pending services exist, False otherwise
+*/
 static bool listServiceBookings(util::Map<std::string, const ServiceBooking*>& currentBookings, int& bookingsSize, util::Map<int, const ServiceBooking*>& serviceBookingsMap)
 {
 	int currentIndex = 1;
@@ -107,6 +117,14 @@ static bool listServiceBookings(util::Map<std::string, const ServiceBooking*>& c
 	return true;
 }
 
+/*
+Function: selectPendingServiceBookings (static helper)
+Description: Allows selection of a pending service booking by index.
+Parameters:
+	- serviceBookingsMap: util::Map<int, const ServiceBooking*>&, map of indexed bookings
+Returns:
+	- const ServiceBooking*: Pointer to the selected booking, or nullptr if invalid
+*/
 static const ServiceBooking* selectPendingServiceBookings(util::Map<int, const ServiceBooking*>& serviceBookingsMap)
 {
 	int userInputIndex;
@@ -123,6 +141,16 @@ static const ServiceBooking* selectPendingServiceBookings(util::Map<int, const S
 	}
 }
 
+/*
+Function: listAvailableTechnicians (static helper)
+Description: Lists all available technicians and maps them to indices for selection.
+Parameters:
+	- currentAvailableTechnicians: util::Map<std::string, const User*>, available technicians
+	- numberOfTechnicians: int, number of technicians
+	- currentAvailableTechniciansMap: util::Map<int, const User*>&, map of indexed technicians
+Returns:
+	- void
+*/
 static void listAvailableTechnicians( util::Map<std::string, const User*> currentAvailableTechnicians, int numberOfTechnicians, util::Map<int, const User*>& currentAvailableTechniciansMap)
 {
 	bool hasTechnicians = false;
@@ -153,6 +181,14 @@ static void listAvailableTechnicians( util::Map<std::string, const User*> curren
 	}
 }
 
+/*
+Function: selectTechnician (static helper)
+Description: Allows selection of a technician by index.
+Parameters:
+	- currentAvailableTechniciansMap: util::Map<int, const User*>&, map of indexed technicians
+Returns:
+	- const User*: Pointer to the selected technician, or nullptr if invalid
+*/
 static const User* selectTechnician(util::Map<int, const User*>& currentAvailableTechniciansMap)
 {
 	int userInputIndex;
@@ -168,6 +204,15 @@ static const User* selectTechnician(util::Map<int, const User*>& currentAvailabl
 	}
 }
 
+/*
+Function: assignJob
+Description: Allows the admin to assign pending service bookings to available technicians.
+			 Creates job cards for selected services.
+Parameters:
+	- None
+Returns:
+	- void
+*/
 void AdminMenu::assignJob()
 {
 	util::clear();
@@ -205,6 +250,15 @@ void AdminMenu::assignJob()
 
 }
 
+/*
+Function: selectInventoryItems (static helper)
+Description: Allows selection of inventory items by index for creating a service.
+Parameters:
+	- currentInventoryItems: util::Map<std::string, const InventoryItem*>&, available inventory items
+	- selectedInventoryItems: util::Vector<std::string>&, vector to store selected item IDs
+Returns:
+	- void
+*/
 static void selectInventoryItems(util::Map<std::string, const InventoryItem*>& currentInventoryItems, util::Vector<std::string>& selectedInventoryItems)
 {
 	bool doRun = true, hasInventoryItems = false;
@@ -270,6 +324,14 @@ static void selectInventoryItems(util::Map<std::string, const InventoryItem*>& c
 	}
 }
 
+/*
+Function: createService
+Description: Allows the admin to create a new service by selecting inventory items and specifying labor cost.
+Parameters:
+	- None
+Returns:
+	- void
+*/
 void AdminMenu::createService()
 {
 	util::clear();
@@ -286,6 +348,14 @@ void AdminMenu::createService()
     std::cout << "Service created sucessfully.\n";
 }
 
+/*
+Function: selectServicesToRemove (static helper)
+Description: Allows selection of a service to remove by index.
+Parameters:
+	- currentServices: util::Map<std::string, const Service*>, available services
+Returns:
+	- std::string: ID of the selected service, or empty string if invalid
+*/
 static std::string selectServicesToRemove(util::Map<std::string, const Service*> currentServices)
 {
     util::Map<int, const Service*> currentServicesMap;
@@ -331,6 +401,14 @@ static std::string selectServicesToRemove(util::Map<std::string, const Service*>
     }
 }
 
+/*
+Function: removeService
+Description: Allows the admin to remove an existing service by selecting from available services.
+Parameters:
+	- None
+Returns:
+	- void
+*/
 void AdminMenu::removeService()
 {
 	util::clear();

Trenser.VehicleServiceSystem/Trenser.VehicleServiceSystem/views/CustomerMenu.cpp

@@ -55,6 +55,15 @@ void CustomerMenu::selectComboPackage()
 {
 }
 
+/*
+Function: viewServiceHistory
+Description: Displays the customer’s past service bookings in tabular format,
+             including booking ID, technician, vehicle details, discount percentage, and status.
+Parameters:
+    - None
+Returns:
+    - void
+*/
 void CustomerMenu::viewServiceHistory()
 {
 	util::clear();

Trenser.VehicleServiceSystem/Trenser.VehicleServiceSystem/views/TechnicianMenu.cpp

@@ -35,6 +35,15 @@ bool TechnicianMenu::handleOperation(int choice)
 	return false;
 }
 
+/*
+Function: selectJobCardToComplete (static helper)
+Description: Lists all incomplete job cards assigned to the technician and allows selection by index.
+Parameters:
+    - assignedJobCards: util::Map<std::string, const JobCard*>&, job cards assigned to the technician
+    - incompleteJobCards: util::Map<int, const JobCard*>&, map of incomplete job cards indexed for selection
+Returns:
+    - std::string: ID of the selected job card, or empty string if none selected
+*/
 static std::string selectJobCardToComplete(util::Map<std::string, const JobCard*>& assignedJobCards, util::Map<int, const JobCard*>& incompleteJobCards)
 {
     int currentIndex = 1;
@@ -82,6 +91,15 @@ static std::string selectJobCardToComplete(util::Map<std::string, const JobCard*
     }
 }
 
+/*
+Function: completeJob
+Description: Allows the technician to mark a selected job card as completed.
+             Validates selection and updates job status through the controller.
+Parameters:
+    - None
+Returns:
+    - void
+*/
 void TechnicianMenu::completeJob()
 {
 	util::Map<std::string, const JobCard*> assignedJobCards = m_controller.getJobCardsByUser();