Add documentation headers across system modules

Trenser.VehicleServiceSystem/Trenser.VehicleServiceSystem/models/InventoryItem.cpp

@@ -19,6 +19,19 @@ InventoryItem::InventoryItem(const std::string& partName, int quantity, double p
     m_status(util::State::ACTIVE),
     m_price(price) {}
 
+/*
+Function: InventoryItem (parameterized constructor with ID)
+Description: Initializes an inventory item with an existing ID, part name, quantity,
+             price, and state. Updates UID tracking based on ID.
+Parameters:
+    - id: const std::string&, unique ID of the item
+    - partName: const std::string&, name of the part
+    - quantity: int, quantity of the part
+    - price: double, price of the part
+    - status: util::State, state of the item (ACTIVE/INACTIVE)
+Returns:
+    - A new InventoryItem object
+*/
 InventoryItem::InventoryItem(const std::string& id, const std::string& partName, int quantity, double price, util::State status)
     : m_id(id),
     m_partName(partName),
@@ -83,6 +96,14 @@ void InventoryItem::setState(util::State status)
     m_status = status;
 }
 
+/*
+Function: serialize
+Description: Serializes the inventory item into a CSV-formatted string.
+Parameters:
+    - None
+Returns:
+    - std::string: Serialized inventory item record
+*/
 std::string InventoryItem::serialize() const
 {
     std::ostringstream serializedInventoryItem;
@@ -94,6 +115,16 @@ std::string InventoryItem::serialize() const
     return serializedInventoryItem.str();
 }
 
+/*
+Function: deserialize
+Description: Deserializes a CSV-formatted string into an InventoryItem object.
+Parameters:
+    - record: const std::string&, serialized inventory item record
+Returns:
+    - InventoryItem*: Pointer to the deserialized InventoryItem object
+Throws:
+    - std::runtime_error if data is invalid
+*/
 InventoryItem* InventoryItem::deserialize(const std::string& record)
 {
     std::string id, partName;
@@ -125,7 +156,15 @@ InventoryItem* InventoryItem::deserialize(const std::string& record)
     );
 }
 
+/*
+Function: getHeaders
+Description: Retrieves the CSV headers for inventory item serialization.
+Parameters:
+    - None
+Returns:
+    - std::string: Header string ("ID,PartName,Quantity,Price,Status")
+*/
 std::string InventoryItem::getHeaders()
 {
     return "ID,PartName,Quantity,Price,Status";
-}
+}