Add file and function header documentation across Model files

2026-04-08 17:23:47 +05:30
parent def0f4022b
commit 9a791eadcd
20 changed files with 121 additions and 0 deletions
@@ -1 +1,7 @@
+/*
+ * File: Admin.cpp
+ * Description: Admin model class
+ * Author: Trenser
+ * Created: 31-Mar-2026
+ */
 #include "Admin.h"
@@ -1,3 +1,10 @@
+/*
+ * File: Admin.h
+ * Description: Admin model class
+ * Author: Trenser
+ * Created: 31-Mar-2026
+ */
+
 #pragma once
 #include "Employee.h"

@@ -1,3 +1,9 @@
+/*
+ * File: Announcement.cpp
+ * Description: The Announcement class that stores an announcement’s ID, timestamp, and message with getter and setter functions for controlled access.
+ * Author: Trenser
+ * Created: 31-Mar-2026
+ */
 #include "Announcement.h"

 const std::string& Announcement::getAnnouncementId() const
@@ -1,3 +1,9 @@
+/*
+ * File: Attendance.cpp
+ * Description: The Attendance class manages attendance records by storing login and logout times.
+ * Author: Trenser
+ * Created: 31-Mar-2026
+ */
 #include "Attendance.h"

 const std::string& Attendance::getAttendanceId() const
@@ -1,3 +1,9 @@
+/*
+ * File: Attendance.h
+ * Description: The Attendance class represents an attendance record by storing an ID, login and logout timestamps.
+ * Author: Trenser
+ * Created: 31-Mar-2026
+ */
 #pragma once
 #include <string>
 #include "Timestamp.h"
@@ -1,3 +1,9 @@
+/*
+ * File: Booking.cpp
+ * Description: The Booking class stores booking details and calculates the duration between start and end times.
+ * Author: Trenser
+ * Created: 31-Mar-2026
+ */
 #include "Booking.h"

 const std::string& Booking::getBookingId() const
@@ -1,3 +1,9 @@
+/*
+ * File: Booking.h
+ * Description: The Booking class represents a time?based booking with employee and team details and supports duration calculation.
+ * Author: Trenser
+ * Created: 31-Mar-2026
+ */
 #pragma once
 #include <string>
 #include <memory>
@@ -1,3 +1,9 @@
+/*
+ * File: Candidate.cpp
+ * Description: The Candidate class manages candidate details and status using getter and setter methods.
+ * Author: Trenser
+ * Created: 31-Mar-2026
+ */
 #include "Candidate.h"

 const std::string& Candidate::getCandidateId() const
@@ -1,3 +1,9 @@
+/*
+ * File: Candidate.h
+ * Description: The Candidate class stores and manages a candidate’s information.
+ * Author: Trenser
+ * Created: 31-Mar-2026
+ */
 #pragma once
 #include <string>
 #include "Enums.h"
@@ -1,3 +1,9 @@
+/*
+ * File: Employee.cpp
+ * Description: The Employee class stores and manages employee details along with related work records.
+ * Author: Trenser
+ * Created: 31-Mar-2026
+ */
 #include "Employee.h"

 const std::string& Employee::getEmployeeId() const
@@ -1,3 +1,9 @@
+/*
+ * File: Employee.h
+ * Description: The Employee class manages employee information and associated work records such as payroll, attendance, leaves, and payslips.
+ * Author: Trenser
+ * Created: 31-Mar-2026
+ */
 #pragma once
 #include <string>
 #include <memory>
@@ -1 +1,7 @@
+/*
+ * File: Faq.h
+ * Description: Faq model class.
+ * Author: Trenser
+ * Created: 02-Apr-2026
+ */
 #include "Faq.h"
@@ -1,3 +1,9 @@
+/*
+ * File: Faq.h
+ * Description: Faq model class.
+ * Author: Trenser
+ * Created: 02-Apr-2026
+ */
 #pragma once

 class Faq
@@ -1 +1,7 @@
+/*
+ * File: FinanceExecutive.h
+ * Description: FinanceExecutive model class.
+ * Author: Trenser
+ * Created: 31-Mar-2026
+ */
 #include "FinanceExecutive.h"
@@ -1,3 +1,9 @@
+/*
+ * File: FinanceExecutive.h
+ * Description: FinanceExecutive model class.
+ * Author: Trenser
+ * Created: 31-Mar-2026
+ */
 #pragma once
 #include "Employee.h"

@@ -1,3 +1,9 @@
+/*
+ * File: GeneralEmployee.h
+ * Description: The GeneralEmployee class represents a general employee with a specific designation.
+ * Author: Trenser
+ * Created: 31-Mar-2026
+ */
 #pragma once
 #include "Employee.h"
 #include "Enums.h"
@@ -1 +1,7 @@
+/*
+ * File: HRManager.cpp
+ * Description: HRManager model class.
+ * Author: Trenser
+ * Created: 31-Mar-2026
+ */
 #include "HRManager.h"
@@ -1,3 +1,9 @@
+/*
+ * File: HRManager.h
+ * Description: HRManager model class.
+ * Author: Trenser
+ * Created: 31-Mar-2026
+ */
 #pragma once
 #include "Employee.h"

@@ -1 +1,7 @@
+/*
+ * File: ITExecutive.cpp
+ * Description: ITExecutive model class.
+ * Author: Trenser
+ * Created: 31-Mar-2026
+ */
 #include "ITExecutive.h"
@@ -1,3 +1,9 @@
+/*
+ * File: ITExecutive.h
+ * Description: ITExecutive model class.
+ * Author: Trenser
+ * Created: 31-Mar-2026
+ */
 #pragma once
 #include "Employee.h"