From 6496fcbc857c4a6ee678057c536bc7a0aef74dde Mon Sep 17 00:00:00 2001
From: Princy Jerin <princy.jerin@trenser.com>
Date: Fri, 17 Apr 2026 10:32:12 +0530
Subject: [PATCH] Add function headers to models

---
 Trenser.Zenvy/Trenser.Zenvy/models/Log.cpp    |  1 -
 .../Trenser.Zenvy/models/Payroll.cpp          | 28 +++++++++++++++----
 Trenser.Zenvy/Trenser.Zenvy/models/Payroll.h  |  2 +-
 .../Trenser.Zenvy/models/Payslip.cpp          | 28 +++++++++++++++----
 Trenser.Zenvy/Trenser.Zenvy/models/Payslip.h  |  2 +-
 Trenser.Zenvy/Trenser.Zenvy/models/Room.cpp   |  8 ++++++
 .../Trenser.Zenvy/models/TalentExecutive.h    |  3 +-
 .../Trenser.Zenvy/models/TeamExecutive.h      |  3 +-
 8 files changed, 56 insertions(+), 19 deletions(-)

diff --git a/Trenser.Zenvy/Trenser.Zenvy/models/Log.cpp b/Trenser.Zenvy/Trenser.Zenvy/models/Log.cpp
index 15ff4ce..579b908 100644
--- a/Trenser.Zenvy/Trenser.Zenvy/models/Log.cpp
+++ b/Trenser.Zenvy/Trenser.Zenvy/models/Log.cpp
@@ -6,7 +6,6 @@ File: Log.cpp
 */
 #include "Log.h"
 
-//Getters and setters
 const util::Timestamp& Log::getTimestamp() const
 {
     return m_timestamp;
diff --git a/Trenser.Zenvy/Trenser.Zenvy/models/Payroll.cpp b/Trenser.Zenvy/Trenser.Zenvy/models/Payroll.cpp
index d5afbdb..ba958ce 100644
--- a/Trenser.Zenvy/Trenser.Zenvy/models/Payroll.cpp
+++ b/Trenser.Zenvy/Trenser.Zenvy/models/Payroll.cpp
@@ -73,6 +73,11 @@ double Payroll::getEmployerPFContribution() const
     return m_employerPFContribution;
 }
 
+std::string Payroll::getHeaders()
+{
+    return "PayrollId,EmployeeId,BasicSalary,HouseRentAllowance,FoodAllowance,EmployeePFContribution,EmployerPFContribution";
+}
+
 void Payroll::setBasicSalary(double basicSalary)
 {
     m_basicSalary = basicSalary;
@@ -98,6 +103,14 @@ void Payroll::setEmployerPFContribution(double value)
     m_employerPFContribution = value;
 }
 
+/*
+Function: serialize
+Description: Converts the payroll object into a comma-separated string.
+Parameters:
+    None
+Returns:
+    A serialized string representation of the payroll.
+*/
 std::string Payroll::serialize() const
 {
     std::ostringstream serializedPayroll;
@@ -111,6 +124,14 @@ std::string Payroll::serialize() const
     return serializedPayroll.str();
 }
 
+/*
+Function: deserialize
+Description: Creates a Payroll object from a serialized comma-separated string.
+Parameters:
+    record - Serialized payroll data.
+Returns:
+    Pointer to a Payroll object.
+*/
 Payroll* Payroll::deserialize(const std::string& record)
 {
     std::string id, employeeId;
@@ -144,9 +165,4 @@ Payroll* Payroll::deserialize(const std::string& record)
 	{
         throw std::runtime_error("Failed to deserialize Payroll object");
     }
-}
-
-std::string Payroll::getHeaders()
-{
-    return "PayrollId,EmployeeId,BasicSalary,HouseRentAllowance,FoodAllowance,EmployeePFContribution,EmployerPFContribution";
-}
+}
\ No newline at end of file
diff --git a/Trenser.Zenvy/Trenser.Zenvy/models/Payroll.h b/Trenser.Zenvy/Trenser.Zenvy/models/Payroll.h
index ebf13ed..7b4699b 100644
--- a/Trenser.Zenvy/Trenser.Zenvy/models/Payroll.h
+++ b/Trenser.Zenvy/Trenser.Zenvy/models/Payroll.h
@@ -54,6 +54,7 @@ public:
     double getFoodAllowance() const;
     double getEmployeePFContribution() const;
     double getEmployerPFContribution() const;
+    static std::string getHeaders();
     void setBasicSalary(double);
     void setHouseRentAllowance(double);
     void setFoodAllowance(double);
@@ -61,5 +62,4 @@ public:
     void setEmployerPFContribution(double);
     std::string serialize() const;
     static Payroll* deserialize(const std::string&);
-    static std::string getHeaders();
 };
\ No newline at end of file
diff --git a/Trenser.Zenvy/Trenser.Zenvy/models/Payslip.cpp b/Trenser.Zenvy/Trenser.Zenvy/models/Payslip.cpp
index e0198f2..1f4f705 100644
--- a/Trenser.Zenvy/Trenser.Zenvy/models/Payslip.cpp
+++ b/Trenser.Zenvy/Trenser.Zenvy/models/Payslip.cpp
@@ -57,6 +57,19 @@ const std::string& Payslip::getEmployeeId() const
     return m_employeeId;
 }
 
+std::string Payslip::getHeaders()
+{
+    return "PayslipId,EmployeeId,Salary,Timestamp";
+}
+
+/*
+Function: serialize
+Description: Converts the payslip object into a comma-separated string.
+Parameters:
+    None
+Returns:
+    A serialized string representation of the payslip.
+*/
 std::string Payslip::serialize() const
 {
     std::ostringstream serializedPayslip;
@@ -67,6 +80,14 @@ std::string Payslip::serialize() const
     return serializedPayslip.str();
 }
 
+/*
+Function: deserialize
+Description: Creates a Payslip object from a serialized comma-separated string.
+Parameters:
+    record - Serialized payslip data.
+Returns:
+    Pointer to a Payslip object.
+*/
 Payslip* Payslip::deserialize(const std::string& record)
 {
     std::string id, employeeId, timestampString;
@@ -92,9 +113,4 @@ Payslip* Payslip::deserialize(const std::string& record)
 	{
         throw std::runtime_error("Failed to deserialize Payslip object");
     }
-}
-
-std::string Payslip::getHeaders()
-{
-    return "PayslipId,EmployeeId,Salary,Timestamp";
-}
+}
\ No newline at end of file
diff --git a/Trenser.Zenvy/Trenser.Zenvy/models/Payslip.h b/Trenser.Zenvy/Trenser.Zenvy/models/Payslip.h
index e5e617f..108b9c5 100644
--- a/Trenser.Zenvy/Trenser.Zenvy/models/Payslip.h
+++ b/Trenser.Zenvy/Trenser.Zenvy/models/Payslip.h
@@ -25,11 +25,11 @@ public:
         util::Timestamp timestamp);
     const std::string& getId() const;
     double getSalary() const;
+    static std::string getHeaders();
     void setPayslipId(const std::string& id);
     void setSalary(double salary);
     const util::Timestamp& getTimestamp() const;
     const std::string& getEmployeeId() const;
     std::string serialize() const;
     static Payslip* deserialize(const std::string&);
-    static std::string getHeaders();
 };
\ No newline at end of file
diff --git a/Trenser.Zenvy/Trenser.Zenvy/models/Room.cpp b/Trenser.Zenvy/Trenser.Zenvy/models/Room.cpp
index b760a32..6c1df34 100644
--- a/Trenser.Zenvy/Trenser.Zenvy/models/Room.cpp
+++ b/Trenser.Zenvy/Trenser.Zenvy/models/Room.cpp
@@ -33,6 +33,14 @@ void Room::setRoomName(const std::string& name)
     m_name = name;
 }
 
+/*
+Function: addBooking
+Description: Adds a valid booking to the room’s booking list using the booking ID as the key.
+Parameters: 
+    booking - A pointer to a Booking object to be added to the room.
+Returns:
+    void
+*/
 void Room::addBooking(Booking* booking)
 {
     if (booking)
diff --git a/Trenser.Zenvy/Trenser.Zenvy/models/TalentExecutive.h b/Trenser.Zenvy/Trenser.Zenvy/models/TalentExecutive.h
index 06b31a4..9ddde43 100644
--- a/Trenser.Zenvy/Trenser.Zenvy/models/TalentExecutive.h
+++ b/Trenser.Zenvy/Trenser.Zenvy/models/TalentExecutive.h
@@ -36,5 +36,4 @@ public:
             accountStatus) {
     }
     ~TalentExecutive() = default;
-};
-
+};
\ No newline at end of file
diff --git a/Trenser.Zenvy/Trenser.Zenvy/models/TeamExecutive.h b/Trenser.Zenvy/Trenser.Zenvy/models/TeamExecutive.h
index 84e1b3f..b550be3 100644
--- a/Trenser.Zenvy/Trenser.Zenvy/models/TeamExecutive.h
+++ b/Trenser.Zenvy/Trenser.Zenvy/models/TeamExecutive.h
@@ -35,5 +35,4 @@ public:
             Enums::EmployeeType::TEAM,
             accountStatus) {}
     ~TeamExecutive() = default;
-};
-
+};
\ No newline at end of file