Add documentation headers across system modules
This commit is contained in:
@@ -1,8 +1,27 @@
|
||||
/*
|
||||
File: CustomerMenu.cpp
|
||||
Description: Implements the CustomerMenu class which provides the customer’s console interface
|
||||
in the Vehicle Service Management System. Handles menu display, user input, and
|
||||
customer-specific operations such as booking services, viewing history, managing payments,
|
||||
invoices, and notifications.
|
||||
Author: Trenser
|
||||
Date: 19-May-2026
|
||||
*/
|
||||
|
||||
#include "CustomerMenu.h"
|
||||
#include "InputHelper.h"
|
||||
#include "OutputHelper.h"
|
||||
#include "MenuHelper.h"
|
||||
|
||||
/*
|
||||
Function: showMenu
|
||||
Description: Displays the customer menu in a loop until the user chooses to logout.
|
||||
Handles exceptions and ensures smooth user interaction.
|
||||
Parameters:
|
||||
- None
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void CustomerMenu::showMenu()
|
||||
{
|
||||
bool isMenuActive = true;
|
||||
@@ -64,11 +83,27 @@ void CustomerMenu::viewInvoices()
|
||||
{
|
||||
}
|
||||
|
||||
/*
|
||||
Function: viewNotifications
|
||||
Description: Displays notifications for the customer and allows deletion of notifications.
|
||||
Parameters:
|
||||
- None
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void CustomerMenu::viewNotifications()
|
||||
{
|
||||
viewAndDeleteNotification(m_controller);
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getNotificationPreference (static helper)
|
||||
Description: Helper function to configure notification preferences for a specific service.
|
||||
Parameters:
|
||||
- serviceName: Name of the service for which notifications are being configured.
|
||||
Returns:
|
||||
- bool: True if notifications are enabled, False if disabled.
|
||||
*/
|
||||
static bool getNotificationPreference(const std::string& serviceName)
|
||||
{
|
||||
int choice;
|
||||
@@ -94,6 +129,14 @@ static bool getNotificationPreference(const std::string& serviceName)
|
||||
}
|
||||
}
|
||||
|
||||
/*
|
||||
Function: configureNotifications
|
||||
Description: Allows the customer to configure notification preferences for payment and service management.
|
||||
Parameters:
|
||||
- None
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void CustomerMenu::configureNotifications()
|
||||
{
|
||||
bool paymentServiceNotifications = getNotificationPreference("Payment Management Service");
|
||||
|
||||
Reference in New Issue
Block a user