Add files and function header documentation across Views

2026-04-08 17:29:01 +05:30
parent 2757e5ca98
commit 6c05d2b352
18 changed files with 288 additions and 0 deletions
@@ -1,8 +1,24 @@
+/*
+ * File: AdminMenu.cpp
+ * Description: Handles user-related operations such as creation, authentication, and validation.
+ * Author: Trenser
+ * Created: 02-Apr-2026
+ */
+
 #include <iostream>
 #include "AdminMenu.h"
 #include"InputHelper.h"
 #include"OutputHelper.h"

+ /*
+  * Function: AdminMenu::run
+  * Description: Starts and manages the administrator menu loop. Continuously displays
+  *              options to the administrator until logout is selected or an exception occurs.
+  * Parameters:
+  *    None
+  * Returns:
+  *    None
+  */
 void AdminMenu::run()
 {
 	bool isMenuActive = true;
@@ -27,6 +43,15 @@ void AdminMenu::run()
 	}
 }

+/*
+ * Function: AdminMenu::handleOperation
+ * Description: Processes the administrator’s menu choice and executes the corresponding action.
+ * Parameters:
+ *    choice - integer representing the selected menu option
+ * Returns:
+ *    true  - if the menu should remain active
+ *    false - if the administrator chooses to logout
+ */
 bool AdminMenu::handleOperation(int choice)
 {
 	switch (choice)
@@ -1,3 +1,10 @@
+/*
+ * File: AdminMenu.h
+ * Description: Declaration of the AdminMenu class and related functions.
+ * Author: Trenser
+ * Created: 02-Apr-2026
+ */
+
 #pragma once
 #include<memory>
 #include"ZenvyController.h"
@@ -1,8 +1,23 @@
+/*
+ * File: EmployeeMenu.cpp
+ * Description: Implements the EmployeeMenu class functions including menu loop and operation handling.
+ * Author: Trenser
+ * Created: 02-Apr-2026
+ */
+
 #include <iostream>
 #include "EmployeeMenu.h"
 #include"InputHelper.h"
 #include"OutputHelper.h"

+ /*
+  * Function: EmployeeMenu::run
+  * Description: Starts the employee menu loop and displays available options until logout is selected
+  * Parameters:
+  *    None
+  * Returns:
+  *    None
+  */
 void EmployeeMenu::run()
 {
 	bool isMenuActive = true;
@@ -27,6 +42,15 @@ void EmployeeMenu::run()
 	}
 }

+/*
+ * Function: EmployeeMenu::handleOperation
+ * Description: Handles the employee’s menu choice and executes the corresponding action
+ * Parameters:
+ *    choice - integer representing the selected menu option
+ * Returns:
+ *    true  - if the menu should remain active
+ *    false - if the employee chooses to logout
+ */
 bool EmployeeMenu::handleOperation(int choice)
 {
 	switch (choice)
@@ -1,3 +1,10 @@
+/*
+ * File: EmployeeMenu.h
+ * Description: Declaration of the EmployeeMenu class and related functions.
+ * Author: Trenser
+ * Created: 02-Apr-2026
+ */
+
 #pragma once
 #include<memory>
 #include"ZenvyController.h"
@@ -1,8 +1,23 @@
+/*
+ * File: FinanceExecutiveMenu.cpp
+ * Description: Implements the FinanceExecutiveMenu class functions including menu loop and operation handling.
+ * Author: Trenser
+ * Created: 02-Apr-2026
+ */
+
 #include <iostream>
 #include "FinanceExecutiveMenu.h"
 #include"InputHelper.h"
 #include"OutputHelper.h"

+/*
+ * Function: FinanceExecutiveMenu::run
+ * Description: Starts the finance executive menu loop and displays available options until logout is selected
+ * Parameters:
+ *    None
+ * Returns:
+ *    None
+ */
 void FinanceExecutiveMenu::run()
 {
 	bool isMenuActive = true;
@@ -27,6 +42,15 @@ void FinanceExecutiveMenu::run()
 	}
 }

+/*
+ * Function: FinanceExecutiveMenu::handleOperation
+ * Description: Handles the finance executive’s menu choice and executes the corresponding action
+ * Parameters:
+ *    choice - integer representing the selected menu option
+ * Returns:
+ *    true  - if the menu should remain active
+ *    false - if the finance executive chooses to logout
+ */
 bool FinanceExecutiveMenu::handleOperation(int choice)
 {
 	switch (choice)
@@ -1,3 +1,10 @@
+/*
+ * File: FinanceExecutiveMenu.h
+ * Description: Declaration of the FinanceExecutiveMenu class and related functions.
+ * Author: Trenser
+ * Created: 02-Apr-2026
+ */
+
 #pragma once
 #include<memory>
 #include"ZenvyController.h"
@@ -1,8 +1,23 @@
+/*
+ * File: HRManagerMenu.cpp
+ * Description: Implements the HRManagerMenu class functions including menu loop and operation handling.
+ * Author: Trenser
+ * Created: 02-Apr-2026
+ */
+
 #include <iostream>
 #include "HRManagerMenu.h"
 #include"InputHelper.h"
 #include"OutputHelper.h"

+/*
+ * Function: HRManagerMenu::run
+ * Description: Starts the HR manager menu loop and displays available options until logout is selected
+ * Parameters:
+ *    None
+ * Returns:
+ *    None
+ */
 void HRManagerMenu::run()
 {
 	bool isMenuActive = true;
@@ -27,6 +42,15 @@ void HRManagerMenu::run()
 	}
 }

+/*
+ * Function: HRManagerMenu::handleOperation
+ * Description: Handles the HR manager’s menu choice and executes the corresponding action
+ * Parameters:
+ *    choice - integer representing the selected menu option
+ * Returns:
+ *    true  - if the menu should remain active
+ *    false - if the HR manager chooses to logout
+ */
 bool HRManagerMenu::handleOperation(int choice)
 {
 	switch (choice)
@@ -1,3 +1,10 @@
+/*
+ * File: HRManagerMenu.h
+ * Description: Declaration of the EmployeeMenu class and related functions.
+ * Author: Trenser
+ * Created: 02-Apr-2026
+ */
+
 #pragma once
 #include<memory>
 #include"ZenvyController.h"
@@ -1,8 +1,23 @@
+/*
+ * File: ITExecutiveMenu.cpp
+ * Description: Implements the ITExecutiveMenu class functions including menu loop and operation handling.
+ * Author: Trenser
+ * Created: 02-Apr-2026
+ */
+
 #include <iostream>
 #include "ITExecutiveMenu.h"
 #include"InputHelper.h"
 #include"OutputHelper.h"

+/*
+ * Function: ITExecutiveMenu::run
+ * Description: Starts the IT executive menu loop and displays available options until logout is selected
+ * Parameters:
+ *    None
+ * Returns:
+ *    None
+ */
 void ITExecutiveMenu::run()
 {
 	bool isMenuActive = true;
@@ -27,6 +42,15 @@ void ITExecutiveMenu::run()
 	}
 }

+/*
+ * Function: ITExecutiveMenu::handleOperation
+ * Description: Handles the IT executive’s menu choice and executes the corresponding action
+ * Parameters:
+ *    choice - integer representing the selected menu option
+ * Returns:
+ *    true  - if the menu should remain active
+ *    false - if the IT executive chooses to logout
+ */
 bool ITExecutiveMenu::handleOperation(int choice)
 {
 	switch (choice)
@@ -1,3 +1,10 @@
+/*
+ * File: ITExecutiveMenu.h
+ * Description: Declaration of the ITExecutiveMenu class and related functions.
+ * Author: Trenser
+ * Created: 02-Apr-2026
+ */
+
 #pragma once
 #include<memory>
 #include"ZenvyController.h"
@@ -1,8 +1,23 @@
+/*
+ * File: TalentExecutiveMenu.cpp
+ * Description: Implements the TalentExecutiveMenu class functions including menu loop and operation handling.
+ * Author: Trenser
+ * Created: 02-Apr-2026
+ */
+
 #include <iostream>
 #include "TalentExecutiveMenu.h"
 #include"InputHelper.h"
 #include"OutputHelper.h"

+/*
+ * Function: TalentExecutiveMenu::run
+ * Description: Starts the talent executive menu loop and displays available options until logout is selected
+ * Parameters:
+ *    None
+ * Returns:
+ *    None
+ */
 void TalentExecutiveMenu::run()
 {
 	bool isMenuActive = true;
@@ -27,6 +42,15 @@ void TalentExecutiveMenu::run()
 	}
 }

+/*
+ * Function: TalentExecutiveMenu::handleOperation
+ * Description: Handles the talent executive’s menu choice and executes the corresponding action
+ * Parameters:
+ *    choice - integer representing the selected menu option
+ * Returns:
+ *    true  - if the menu should remain active
+ *    false - if the talent executive chooses to logout
+ */
 bool TalentExecutiveMenu::handleOperation(int choice)
 {
 	switch (choice)
@@ -1,3 +1,10 @@
+/*
+ * File: TalentExecutiveMenu.h
+ * Description: Declaration of the TalentExecutiveMenu class and related functions.
+ * Author: Trenser
+ * Created: 02-Apr-2026
+ */
+
 #pragma once
 #include<memory>
 #include"ZenvyController.h"
@@ -1,8 +1,23 @@
+/*
+ * File: TeamExecutiveMenu.cpp
+ * Description: Implements the TeamExecutiveMenu class functions including menu loop and operation handling.
+ * Author: Trenser
+ * Created: 02-Apr-2026
+ */
+
 #include <iostream>
 #include "TeamExecutiveMenu.h"
 #include"InputHelper.h"
 #include"OutputHelper.h"

+/*
+ * Function: TeamExecutiveMenu::run
+ * Description: Starts the team executive menu loop and displays available options until logout is selected
+ * Parameters:
+ *    None
+ * Returns:
+ *    None
+ */
 void TeamExecutiveMenu::run()
 {
 	bool isMenuActive = true;
@@ -27,6 +42,15 @@ void TeamExecutiveMenu::run()
 	}
 }

+/*
+ * Function: TeamExecutiveMenu::handleOperation
+ * Description: Handles the team executive’s menu choice and executes the corresponding action
+ * Parameters:
+ *    choice - integer representing the selected menu option
+ * Returns:
+ *    true  - if the menu should remain active
+ *    false - if the team executive chooses to logout
+ */
 bool TeamExecutiveMenu::handleOperation(int choice)
 {
 	switch (choice)
@@ -1,3 +1,10 @@
+/*
+ * File: TeamExecutiveMenu.h
+ * Description: Declaration of the TeamExecutiveMenu and related functions.
+ * Author: Trenser
+ * Created: 02-Apr-2026
+ */
+
 #pragma once
 #include<memory>
 #include"ZenvyController.h"
@@ -1,8 +1,23 @@
+/*
+ * File: TeamLeadMenu.cpp
+ * Description: Implements the TeamLeadMenu class functions including menu loop and operation handling.
+ * Author: Trenser
+ * Created: 02-Apr-2026
+ */
+
 #include <iostream>
 #include "TeamLeadMenu.h"
 #include"InputHelper.h"
 #include"OutputHelper.h"

+/*
+ * Function: TeamLeadMenu::run
+ * Description: Starts the team lead menu loop and displays available options until logout is selected
+ * Parameters:
+ *    None
+ * Returns:
+ *    None
+ */
 void TeamLeadMenu::run()
 {
 	bool isMenuActive = true;
@@ -27,6 +42,15 @@ void TeamLeadMenu::run()
 	}
 }

+/*
+ * Function: TeamLeadMenu::handleOperation
+ * Description: Handles the team lead’s menu choice and executes the corresponding action
+ * Parameters:
+ *    choice - integer representing the selected menu option
+ * Returns:
+ *    true  - if the menu should remain active
+ *    false - if the team lead chooses to logout
+ */
 bool TeamLeadMenu::handleOperation(int choice)
 {
 	switch (choice)
@@ -1,3 +1,10 @@
+/*
+ * File: TeamLeadMenu.h
+ * Description: Declaration of the TeamLeadMenu class and related functions.
+ * Author: Trenser
+ * Created: 02-Apr-2026
+ */
+
 #pragma once
 #include<memory>
 #include"ZenvyController.h"
@@ -1,3 +1,10 @@
+/*
+ * File: UserInterface.cpp
+ * Description: Implements the UserInterface class functions including menu loop, login handling, and routing to appropriate role-based menus.
+ * Author: Trenser
+ * Created: 02-Apr-2026
+ */
+
 #include <iostream>
 #include <utility>
 #include <memory>
@@ -16,6 +23,14 @@
 #include "OutputHelper.h"
 #include "Validator.h"

+/*
+ * Function: UserInterface::run
+ * Description: Starts the user interface loop and displays login/exit options until exit is selected
+ * Parameters:
+ *    None
+ * Returns:
+ *    None
+ */
 void UserInterface::run()
 {
 	bool isMenuActive = true;
@@ -40,6 +55,15 @@ void UserInterface::run()
 	}
 }

+/*
+ * Function: UserInterface::handleOperation
+ * Description: Handles the user’s menu choice and executes the corresponding action
+ * Parameters:
+ *    choice - integer representing the selected menu option
+ * Returns:
+ *    true  - if the interface should remain active
+ *    false - if the user chooses to exit
+ */
 bool UserInterface::handleOperation(int choice)
 {
 	switch (choice)
@@ -57,6 +81,14 @@ bool UserInterface::handleOperation(int choice)
 	return true;
 }

+/*
+ * Function: UserInterface::login
+ * Description: Authenticates the user by email and password, validates login status, and routes to the appropriate menu
+ * Parameters:
+ *    None
+ * Returns:
+ *    None
+ */
 void UserInterface::login()
 {
    std::string email, password;
@@ -1,3 +1,10 @@
+/*
+ * File: UserInterface.h
+ * Description: Declaration of the UserInterface class and related functions.
+ * Author: Trenser
+ * Created: 02-Apr-2026
+ */
+
 #pragma once
 #include <memory>
 #include <utility>