Add file and function header documentation across Model files

2026-04-08 17:25:58 +05:30
parent 9a791eadcd
commit 21549b4c24
22 changed files with 163 additions and 0 deletions
@@ -1,5 +1,13 @@
+/*
+File: JobListing.cpp
+* Description : Represents a job opening along with its details and applied candidates.
+* Author : Trenser
+* Created : 01 - Apr - 2026
+*/
+
 #include "JobListing.h"

+//Getters and setters
 const std::string& JobListing::getJobId() const
 {
    return m_id;
@@ -1,3 +1,10 @@
+/*
+File: JobListing.h
+* Description : Represents a job opening along with its details and applied candidates.
+* Author : Trenser
+* Created : 01 - Apr - 2026
+*/
+
 #pragma once
 #include <string>
 #include <map>
@@ -1,5 +1,13 @@
+/*
+File: Leave.cpp
+* Description : Stores information related to an employee’s leave application.
+* Author : Trenser
+* Created : 31 - Mar - 2026
+*/
+
 #include "Leave.h"

+//Getters and setters
 const std::string& Leave::getLeaveId() const
 {
    return m_id;
@@ -1,3 +1,10 @@
+/*
+File: Leave.h
+* Description : Stores information related to an employee’s leave application.
+* Author : Trenser
+* Created : 31 - Mar - 2026
+*/
+
 #pragma once
 #include <string>
 #include "Enums.h"
@@ -1,5 +1,13 @@
+/*
+File: Log.cpp
+* Description : Represents a log entry containing a timestamp and an associated message.
+* Author : Trenser
+* Created : 01 - Apr - 2026
+*/
+
 #include "Log.h"

+//Getters and setters
 const util::Timestamp& Log::getTimestamp() const
 {
    return m_timestamp;
@@ -1,3 +1,10 @@
+/*
+File: Log.h
+* Description : Represents a log entry containing a timestamp and an associated message.
+* Author : Trenser
+* Created : 01 - Apr - 2026
+*/
+
 #pragma once
 #include <string>
 #include "Timestamp.h"
@@ -1,5 +1,13 @@
+/*
+File: Notification.cpp
+* Description : Represents an employee notification with message and status details.
+* Author : Trenser
+* Created : 31 - Mar - 2026
+*/
+
 #include "Notification.h"

+//Getters and setters
 const std::string& Notification::getNotificationId() const
 {
    return m_id;
@@ -1,3 +1,10 @@
+/*
+File: Notification.h
+* Description : Represents an employee notification with message and status details.
+* Author : Trenser
+* Created : 31 - Mar - 2026
+*/
+
 #pragma once
 #include <string>
 #include "Enums.h"
@@ -1,5 +1,13 @@
+/*
+File: Payroll.cpp
+* Description : Stores payroll and salary breakdown details for an employee.
+* Author : Trenser
+* Created : 31 - Mar - 2026
+*/
+
 #include "Payroll.h"

+//Getters and setters
 const std::string& Payroll::getPayrollId() const
 {
    return m_id;
@@ -1,3 +1,10 @@
+/*
+File: Payroll.h
+* Description : Stores payroll and salary breakdown details for an employee.
+* Author : Trenser
+* Created : 31 - Mar - 2026
+*/
+
 #pragma once
 #include <string>

@@ -1,5 +1,13 @@
+/*
+File: Payslip.cpp
+* Description : Models a payslip entity that stores salary information.
+* Author : Trenser
+* Created : 31 - Mar - 2026
+*/
+
 #include "Payslip.h"

+//Getters and setters
 const std::string& Payslip::getPayslipId() const
 {
    return m_id;
@@ -1,3 +1,10 @@
+/*
+File: Payslip.h
+* Description : Models a payslip entity that stores salary information.
+* Author : Trenser
+* Created : 31 - Mar - 2026
+*/
+
 #pragma once
 #include <string>

@@ -1,5 +1,13 @@
+/*
+File: Room.cpp
+* Description : Models a room entity that maintains room details and manages its bookings.
+* Author : Trenser
+* Created : 31 - Mar - 2026
+*/
+
 #include "Room.h"

+//Getters and setters
 const std::string& Room::getRoomId() const
 {
    return m_id;
@@ -1,3 +1,10 @@
+/*
+File: Room.h
+* Description : Models a room entity that maintains room details and manages its bookings.
+* Author : Trenser
+* Created : 31 - Mar - 2026
+*/
+
 #pragma once
 #include <string>
 #include <map>
@@ -1 +1,8 @@
+/*
+File: TalentExecutive.cpp
+* Description : Represents information related to a talent executive in the system.
+* Author : Trenser
+* Created : 31 - Mar - 2026
+*/
+
 #include "TalentExecutive.h"
@@ -1,3 +1,10 @@
+/*
+File: TalentExecutive.h
+* Description : Represents information related to a talent executive in the system.
+* Author : Trenser
+* Created : 31 - Mar - 2026
+*/
+
 #pragma once
 #include "Employee.h"

@@ -1,5 +1,13 @@
+/*
+File: Team.cpp
+* Description : Models a team entity that maintains team identity, leadership, employee list, and size limitations.
+* Author : Trenser
+* Created : 31 - Mar - 2026
+*/
+
 #include "Team.h"

+//Getters and setters
 const std::string& Team::getTeamId() const
 {
    return m_id;
@@ -1,3 +1,10 @@
+/*
+File: Team.h
+* Description : Models a team entity that maintains team identity, leadership, employee list, and size limitations.
+* Author : Trenser
+* Created : 31 - Mar - 2026
+*/
+
 #pragma once
 #include <string>
 #include <map>
@@ -1 +1,8 @@
+/*
+File: TeamExecutive.cpp
+* Description : Represents information related to a team executive within the system.
+* Author : Trenser
+* Created : 31 - Mar - 2026
+*/
+
 #include "TeamExecutive.h"
@@ -1,3 +1,10 @@
+/*
+File: TeamExecutive.h
+* Description : Represents information related to a team executive within the system.
+* Author : Trenser
+* Created : 31 - Mar - 2026
+*/
+
 #pragma once
 #include "Employee.h"

@@ -1,5 +1,13 @@
+/*
+File: Ticket.cpp
+* Description : Represents a support ticket with its associated details and status.
+* Author : Trenser
+* Created : 31 - Mar - 2026
+*/
+
 #include "Ticket.h"

+//Getters and setters
 const std::string& Ticket::getTicketId() const
 {
    return m_id;
@@ -1,3 +1,10 @@
+/*
+File: Ticket.h
+* Description : Represents a support ticket with its associated details and status.
+* Author : Trenser
+* Created : 31 - Mar - 2026
+*/
+
 #pragma once
 #include <string>
 #include "Enums.h"