Add documentation headers across system modules

Trenser.VehicleServiceSystem/Trenser.VehicleServiceSystem/models/Notification.cpp

@@ -1,11 +1,39 @@
+/*
+File: Notification.cpp
+Description: Implements the Notification class which represents system notifications in the Vehicle Service Management System.
+             Provides constructors, accessors, and mutators for notification details such as ID, recipient, title, message, and timestamp.
+Author: Trenser
+Date: 19-May-2026
+*/
+
 #include "Notification.h"
 
 int Notification::m_uid = 0;
 
+/*
+Function: Notification
+Description: Default constructor that initializes a new notification with a unique ID and null recipient.
+Parameters:
+    - None
+Returns:
+    - A new Notification object.
+*/
 Notification::Notification()
     : m_id("NOT" + std::to_string(++m_uid)),
     m_recipient(nullptr) {}
 
+/*
+Function: Notification
+Description: Parameterized constructor that initializes a new notification with a unique ID and specified details.
+Parameters:
+    - recipientUserId: ID of the recipient user.
+    - recipient: Pointer to the User object representing the recipient.
+    - title: Title of the notification.
+    - message: Message content of the notification.
+    - createdAt: Timestamp of when the notification was created.
+Returns:
+    - A new Notification object.
+*/
 Notification::Notification(const std::string& recipientUserId, User* recipient, const std::string& title, const std::string& message, const util::Timestamp& createdAt)
     : m_id("NOT" + std::to_string(++m_uid)),
     m_recipientUserId(recipientUserId),
@@ -14,61 +42,145 @@ Notification::Notification(const std::string& recipientUserId, User* recipient,
     m_message(message),
     m_createdAt(createdAt) {}
 
+/*
+Function: getId
+Description: Retrieves the unique ID of the notification.
+Returns:
+    - const std::string& representing the notification ID.
+*/
 const std::string& Notification::getId() const 
 {
     return m_id;
 }
 
+/*
+Function: getRecipientUserId
+Description: Retrieves the recipient user ID associated with the notification.
+Returns:
+    - const std::string& representing the recipient user ID.
+*/
 const std::string& Notification::getRecipientUserId() const
 {
     return m_recipientUserId;
 }
 
+/*
+Function: getRecipient
+Description: Retrieves the pointer to the recipient user.
+Returns:
+    - User* representing the recipient.
+*/
 User* Notification::getRecipient() const
 {
     return m_recipient;
 }
 
+/*
+Function: getTitle
+Description: Retrieves the title of the notification.
+Returns:
+    - const std::string& representing the notification title.
+*/
 const std::string& Notification::getTitle() const
 {
     return m_title;
 }
 
+/*
+Function: getMessage
+Description: Retrieves the message content of the notification.
+Returns:
+    - const std::string& representing the notification message.
+*/
 const std::string& Notification::getMessage() const
 {
     return m_message;
 }
 
+/*
+Function: getCreatedAt
+Description: Retrieves the timestamp of when the notification was created.
+Returns:
+    - const util::Timestamp& representing the creation timestamp.
+*/
 const util::Timestamp& Notification::getCreatedAt() const
 {
     return m_createdAt;
 }
 
+/*
+Function: setId
+Description: Sets the unique ID of the notification.
+Parameters:
+    - id: New notification ID string.
+Returns:
+    - void
+*/
 void Notification::setId(const std::string& id)
 {
     m_id = id;
 }
 
+/*
+Function: setRecipientUserId
+Description: Sets the recipient user ID for the notification.
+Parameters:
+    - recipientUserId: New recipient user ID string.
+Returns:
+    - void
+*/
 void Notification::setRecipientUserId(const std::string& recipientUserId)
 {
     m_recipientUserId = recipientUserId;
 }
 
+/*
+Function: setRecipient
+Description: Sets the recipient user pointer for the notification.
+Parameters:
+    - recipient: Pointer to the User object.
+Returns:
+    - void
+*/
 void Notification::setRecipient(User* recipient)
 {
     m_recipient = recipient;
 }
 
+/*
+Function: setTitle
+Description: Sets the title of the notification.
+Parameters:
+    - title: New notification title string.
+Returns:
+    - void
+*/
 void Notification::setTitle(const std::string& title)
 {
     m_title = title;
 }
 
+/*
+Function: setMessage
+Description: Sets the message content of the notification.
+Parameters:
+    - message: New notification message string.
+Returns:
+    - void
+*/
 void Notification::setMessage(const std::string& message)
 {
     m_message = message;
 }
 
+/*
+Function: setCreatedAt
+Description: Sets the timestamp of when the notification was created.
+Parameters:
+    - createdAt: New timestamp value.
+Returns:
+    - void
+*/
 void Notification::setCreatedAt(const util::Timestamp& createdAt)
 {
     m_createdAt = createdAt;