Add documentation headers across system modules

Trenser.VehicleServiceSystem/Trenser.VehicleServiceSystem/models/JobCard.cpp

@@ -35,6 +35,22 @@ JobCard::JobCard(const std::string& bookingId,
     m_status(status),
     m_completionDate(completionDate) {}
 
+/*
+Function: JobCard (parameterized constructor with ID)
+Description: Initializes a job card with an existing ID, booking ID, service ID,
+             technician ID, assignment date, completion date, and status.
+             Updates UID tracking based on ID.
+Parameters:
+    - id: const std::string&, unique job card ID
+    - bookingId: const std::string&, ID of the booking
+    - serviceId: const std::string&, ID of the service
+    - technicianId: const std::string&, ID of the technician
+    - assignedDate: const util::Timestamp&, date of assignment
+    - status: util::ServiceJobStatus, job status
+    - completionDate: const util::Timestamp&, date of completion
+Returns:
+    - A new JobCard object
+*/
 JobCard::JobCard(const std::string& id,
     const std::string& bookingId,
     const std::string& serviceId,
@@ -161,6 +177,14 @@ void JobCard::setCompletionDate(const util::Timestamp& completionDate)
     m_completionDate = completionDate;
 }
 
+/*
+Function: serialize
+Description: Serializes the job card into a CSV-formatted string.
+Parameters:
+    - None
+Returns:
+    - std::string: Serialized job card record
+*/
 std::string JobCard::serialize() const
 {
     std::ostringstream serializedJobCard;
@@ -174,6 +198,16 @@ std::string JobCard::serialize() const
     return serializedJobCard.str();
 }
 
+/*
+Function: deserialize
+Description: Deserializes a CSV-formatted string into a JobCard object.
+Parameters:
+    - record: const std::string&, serialized job card record
+Returns:
+    - JobCard*: Pointer to the deserialized JobCard object
+Throws:
+    - std::runtime_error if timestamp parsing fails
+*/
 JobCard* JobCard::deserialize(const std::string& record)
 {
     std::string id, bookingId, serviceId, technicianId;
@@ -209,6 +243,14 @@ JobCard* JobCard::deserialize(const std::string& record)
     );
 }
 
+/*
+Function: getHeaders
+Description: Retrieves the CSV headers for job card serialization.
+Parameters:
+    - None
+Returns:
+    - std::string: Header string ("ID,BookingID,ServiceID,TechnicianID,AssignedDate,Status,CompletionDate")
+*/
 std::string JobCard::getHeaders()
 {
     return "ID,BookingID,ServiceID,TechnicianID,AssignedDate,Status,CompletionDate";