Add standardized documentation headers

2026-05-22 13:26:02 +05:30
parent 826919579c
commit 34cb64ab1b
18 changed files with 544 additions and 1 deletions
@@ -1,3 +1,11 @@
+/*
+File: CustomerMenu.cpp
+Description: Implementation file containing the method definitions of the
+             CustomerMenu class, including menu handling, service selection,
+             combo package booking, profile updates, and password management.
+Author: Trenser
+Date:19-May-2026
+*/
 #include <iomanip>
 #include "CustomerMenu.h"
 #include "Service.h"
@@ -11,6 +19,12 @@
 #include "Utility.h"
 #include "Map.h"

+/*
+Function: showMenu
+Description: Displays the customer menu and handles user input until logout is selected.
+Parameter: None
+Return type: void
+*/
 void CustomerMenu::showMenu()
 {
    while (true)
@@ -45,6 +59,12 @@ void CustomerMenu::showMenu()
    }
 }

+/*
+Function: handleOperation
+Description: Executes the corresponding customer operation based on the selected menu choice.
+Parameter: int choice - selected menu option
+Return type: bool - true if menu continues, false if logout
+*/
 bool CustomerMenu::handleOperation(int choice)
 {
    switch (choice)
@@ -86,11 +106,23 @@ bool CustomerMenu::handleOperation(int choice)
    return true;
 }

+/*
+Function: logout
+Description: Logs out the currently authenticated customer user.
+Parameter: None
+Return type: void
+*/
 void CustomerMenu::logout()
 {
 	m_controller.logout();
 }

+/*
+Function: changePassword
+Description: Allows the customer to change their password after validation.
+Parameter: None
+Return type: void
+*/
 void CustomerMenu::changePassword()
 {
 	std::string newPassword;
@@ -108,6 +140,12 @@ void CustomerMenu::changePassword()
 	util::pressEnter();
 }

+/*
+Function: updateDetails
+Description: Allows the customer to update their email and phone number after validation.
+Parameter: None
+Return type: void
+*/
 void CustomerMenu::updateDetails()
 {
 	std::string email, phone;
@@ -133,6 +171,12 @@ void CustomerMenu::updateDetails()
 	util::pressEnter();
 }

+/*
+Function: selectServiceFromServices
+Description: Displays active services and allows the customer to select one by index.
+Parameter: const util::Map<std::string, const Service*>& services - list of services
+Return type: const Service* - selected service
+*/
 static const Service* selectServiceFromServices(const util::Map<std::string, const Service*>& services)
 {
    util::Map<int, const Service*> activeServicesMap;
@@ -176,6 +220,13 @@ static const Service* selectServiceFromServices(const util::Map<std::string, con
    return activeServicesMap[userInputIndex];
 }

+/*
+Function: selectService
+Description: Allows the customer to select a service, provide vehicle details,
+             and book the service through the controller.
+Parameter: None
+Return type: void
+*/
 void CustomerMenu::selectService()
 {
    std::string vehicleNumber, vehicleBrand, vehicleModel;
@@ -202,6 +253,12 @@ void CustomerMenu::selectService()
    util::pressEnter();
 }

+/*
+Function: selectComboPackageFromPackages
+Description: Displays active combo packages and allows the customer to select one by index.
+Parameter: const util::Map<std::string, const ComboPackage*>& comboPackages - list of combo packages
+Return type: const ComboPackage* - selected combo package
+*/
 static const ComboPackage* selectComboPackageFromPackages(const util::Map<std::string, const ComboPackage*>& comboPackages)
 {
    util::Map<int, const ComboPackage*> activeComboPackages;
@@ -244,6 +301,13 @@ static const ComboPackage* selectComboPackageFromPackages(const util::Map<std::s
    return activeComboPackages[userInputIndex];
 }

+/*
+Function: selectComboPackage
+Description: Allows the customer to select a combo package, provide vehicle details,
+             and book the package through the controller.
+Parameter: None
+Return type: void
+*/
 void CustomerMenu::selectComboPackage()
 {
    std::string vehicleNumber, vehicleBrand, vehicleModel;
@@ -1,3 +1,12 @@
+/*
+File: CustomerMenu.h
+Description: Header file declaring the CustomerMenu class, which provides
+             customer operations such as selecting services, booking combo
+             packages, updating profile details, managing payments, viewing
+             invoices, and configuring notifications.
+Author: Trenser
+Date:19-May-2026
+*/
 #pragma once
 #include "Controller.h"

@@ -1,3 +1,11 @@
+/*
+File: MenuHelper.h
+Description: Header file declaring the MenuHelper class, which provides
+             utility functions for menu-driven operations such as
+             notification selection and display.
+Author: Trenser
+Date:19-May-2026
+*/
 #pragma once
 #include <string>
 #include <iomanip>
@@ -6,6 +14,14 @@
 #include "InputHelper.h"
 #include "OutputHelper.h"

+/*
+Function: selectNotification
+Description: Displays a list of notifications with index, ID, title, and timestamp.
+             Allows the user to select a notification by index. Returns the selected
+             notification or nullptr if the selection is invalid.
+Parameter: const util::Vector<const Notification*>& notifications - list of notifications
+Return type: const Notification* - pointer to the selected notification
+*/
 inline const Notification* selectNotification(const util::Vector<const Notification*>& notifications)
 {
    if (notifications.getSize() == 0)
@@ -1,3 +1,11 @@
+/*
+File: UserInterface.cpp
+Description: Implementation file containing the method definitions of the
+			 UserInterface class, including system run loop, login handling,
+			 and customer registration logic.
+Author: Trenser
+Date:19-May-2026
+*/
 #include "UserInterface.h"
 #include "InputHelper.h"
 #include "OutputHelper.h"
@@ -5,6 +13,13 @@
 #include "User.h"
 #include "Validator.h"

+/*
+Function: run
+Description: Runs the main system loop, displaying the initial menu for login,
+			 customer registration, or exit. Handles exceptions gracefully.
+Parameter: None
+Return type: void
+*/
 void UserInterface::run()
 {
 	bool isMenuActive = true;
@@ -29,6 +44,12 @@ void UserInterface::run()
 	}
 }

+/*
+Function: handleOperation
+Description: Executes the corresponding system operation based on the selected menu choice.
+Parameter: int choice - selected menu option
+Return type: bool - true if menu continues, false if exit
+*/
 bool UserInterface::handleOperation(int choice)
 {
 	switch (choice)
@@ -49,6 +70,13 @@ bool UserInterface::handleOperation(int choice)
 	return true;
 }

+/*
+Function: login
+Description: Handles user login by validating credentials. Based on the authenticated
+			 user type, navigates to the appropriate menu (Admin, Technician, Customer).
+Parameter: None
+Return type: void
+*/
 void UserInterface::login()
 {
 	std::string username, password;
@@ -85,6 +113,14 @@ void UserInterface::login()
 	}
 }

+/*
+Function: registerCustomer
+Description: Registers a new customer by collecting and validating details such as
+			 username, name, email, password, and phone number. Delegates creation
+			 to the controller.
+Parameter: None
+Return type: void
+*/
 void UserInterface::registerCustomer()
 {
 	std::string username, name, email, phone, password;
@@ -1,3 +1,12 @@
+/*
+File: UserInterface.h
+Description: Header file declaring the UserInterface class, which provides
+             the main entry point for the Vehicle Service System. Handles
+             login, customer registration, and menu navigation for different
+             user roles (Admin, Technician, Customer).
+Author: Trenser
+Date:19-May-2026
+*/
 #pragma once
 #include "Controller.h"
 #include "AdminMenu.h"