From 24e3d5ab80974a44a57b4e3b8aced31bcd27be5f Mon Sep 17 00:00:00 2001
From: Harkamal Randhawa <harkamalsr@gmail.com>
Date: Mon, 20 Apr 2026 13:47:08 -0600
Subject: [PATCH] comment backend controllers

---
 .../petshop/backend/controller/ActivityLogController.java   | 6 ++++++
 .../com/petshop/backend/controller/AdoptionController.java  | 6 ++++++
 .../com/petshop/backend/controller/AiChatController.java    | 6 ++++++
 .../com/petshop/backend/controller/AnalyticsController.java | 6 ++++++
 .../petshop/backend/controller/AppointmentController.java   | 6 ++++++
 .../java/com/petshop/backend/controller/AuthController.java | 6 ++++++
 .../java/com/petshop/backend/controller/CartController.java | 6 ++++++
 .../com/petshop/backend/controller/CategoryController.java  | 6 ++++++
 .../java/com/petshop/backend/controller/ChatController.java | 6 ++++++
 .../petshop/backend/controller/ChatWebSocketController.java | 6 ++++++
 .../com/petshop/backend/controller/ContactController.java   | 6 ++++++
 .../com/petshop/backend/controller/CouponController.java    | 6 ++++++
 .../com/petshop/backend/controller/CustomerController.java  | 6 ++++++
 .../com/petshop/backend/controller/DropdownController.java  | 6 ++++++
 .../com/petshop/backend/controller/EmployeeController.java  | 6 ++++++
 .../com/petshop/backend/controller/HealthController.java    | 6 ++++++
 .../com/petshop/backend/controller/InventoryController.java | 6 ++++++
 .../com/petshop/backend/controller/MyPetController.java     | 6 ++++++
 .../java/com/petshop/backend/controller/PetController.java  | 6 ++++++
 .../com/petshop/backend/controller/PetImageController.java  | 6 ++++++
 .../com/petshop/backend/controller/ProductController.java   | 6 ++++++
 .../petshop/backend/controller/ProductImageController.java  | 6 ++++++
 .../backend/controller/ProductSupplierController.java       | 6 ++++++
 .../petshop/backend/controller/PurchaseOrderController.java | 6 ++++++
 .../com/petshop/backend/controller/RefundController.java    | 6 ++++++
 .../java/com/petshop/backend/controller/SaleController.java | 6 ++++++
 .../com/petshop/backend/controller/ServiceController.java   | 6 ++++++
 .../com/petshop/backend/controller/StoreController.java     | 6 ++++++
 .../com/petshop/backend/controller/SupplierController.java  | 6 ++++++
 .../petshop/backend/controller/UserAvatarController.java    | 6 ++++++
 .../java/com/petshop/backend/controller/UserController.java | 6 ++++++
 31 files changed, 186 insertions(+)

diff --git a/backend/src/main/java/com/petshop/backend/controller/ActivityLogController.java b/backend/src/main/java/com/petshop/backend/controller/ActivityLogController.java
index 6d202ddb..35e9f79c 100644
--- a/backend/src/main/java/com/petshop/backend/controller/ActivityLogController.java
+++ b/backend/src/main/java/com/petshop/backend/controller/ActivityLogController.java
@@ -1,3 +1,9 @@
+/*
+ * Handles requests for viewing user activity logs.
+ *
+ * Author: Harkamal
+ * Date: April 2026
+ */
 package com.petshop.backend.controller;
 
 import com.petshop.backend.dto.activity.ActivityLogResponse;
diff --git a/backend/src/main/java/com/petshop/backend/controller/AdoptionController.java b/backend/src/main/java/com/petshop/backend/controller/AdoptionController.java
index 1be65273..2fa0fc71 100644
--- a/backend/src/main/java/com/petshop/backend/controller/AdoptionController.java
+++ b/backend/src/main/java/com/petshop/backend/controller/AdoptionController.java
@@ -1,3 +1,9 @@
+/*
+ * Handles pet adoption requests and approvals.
+ *
+ * Author: Harkamal
+ * Date: April 2026
+ */
 package com.petshop.backend.controller;
 
 import com.petshop.backend.dto.adoption.AdoptionRequest;
diff --git a/backend/src/main/java/com/petshop/backend/controller/AiChatController.java b/backend/src/main/java/com/petshop/backend/controller/AiChatController.java
index a20ef4f7..733cafb4 100644
--- a/backend/src/main/java/com/petshop/backend/controller/AiChatController.java
+++ b/backend/src/main/java/com/petshop/backend/controller/AiChatController.java
@@ -1,3 +1,9 @@
+/*
+ * Handles AI-powered chat for getting pet care advice.
+ *
+ * Author: Harkamal
+ * Date: April 2026
+ */
 package com.petshop.backend.controller;
 
 import com.petshop.backend.dto.ai.AiChatRequest;
diff --git a/backend/src/main/java/com/petshop/backend/controller/AnalyticsController.java b/backend/src/main/java/com/petshop/backend/controller/AnalyticsController.java
index 08aea44d..bd7cde45 100644
--- a/backend/src/main/java/com/petshop/backend/controller/AnalyticsController.java
+++ b/backend/src/main/java/com/petshop/backend/controller/AnalyticsController.java
@@ -1,3 +1,9 @@
+/*
+ * Handles dashboard analytics and sales reporting for staff and admins.
+ *
+ * Author: Harkamal
+ * Date: April 2026
+ */
 package com.petshop.backend.controller;
 
 import com.petshop.backend.dto.analytics.DashboardResponse;
diff --git a/backend/src/main/java/com/petshop/backend/controller/AppointmentController.java b/backend/src/main/java/com/petshop/backend/controller/AppointmentController.java
index 301b4a77..7ce43cd6 100644
--- a/backend/src/main/java/com/petshop/backend/controller/AppointmentController.java
+++ b/backend/src/main/java/com/petshop/backend/controller/AppointmentController.java
@@ -1,3 +1,9 @@
+/*
+ * Handles booking and managing pet service appointments.
+ *
+ * Author: Harkamal
+ * Date: April 2026
+ */
 package com.petshop.backend.controller;
 
 import com.petshop.backend.dto.appointment.AppointmentRequest;
diff --git a/backend/src/main/java/com/petshop/backend/controller/AuthController.java b/backend/src/main/java/com/petshop/backend/controller/AuthController.java
index e1d14e67..ecbaea8d 100644
--- a/backend/src/main/java/com/petshop/backend/controller/AuthController.java
+++ b/backend/src/main/java/com/petshop/backend/controller/AuthController.java
@@ -1,3 +1,9 @@
+/*
+ * Handles user login, registration, password reset, and profile updates.
+ *
+ * Author: Harkamal
+ * Date: April 2026
+ */
 package com.petshop.backend.controller;
 
 import com.petshop.backend.dto.auth.AvatarUploadResponse;
diff --git a/backend/src/main/java/com/petshop/backend/controller/CartController.java b/backend/src/main/java/com/petshop/backend/controller/CartController.java
index 975d786a..bb535b09 100644
--- a/backend/src/main/java/com/petshop/backend/controller/CartController.java
+++ b/backend/src/main/java/com/petshop/backend/controller/CartController.java
@@ -1,3 +1,9 @@
+/*
+ * Handles shopping cart operations like adding and removing items.
+ *
+ * Author: Harkamal
+ * Date: April 2026
+ */
 package com.petshop.backend.controller;
 
 import com.petshop.backend.dto.cart.*;
diff --git a/backend/src/main/java/com/petshop/backend/controller/CategoryController.java b/backend/src/main/java/com/petshop/backend/controller/CategoryController.java
index bbce6ec9..da6f3a9f 100644
--- a/backend/src/main/java/com/petshop/backend/controller/CategoryController.java
+++ b/backend/src/main/java/com/petshop/backend/controller/CategoryController.java
@@ -1,3 +1,9 @@
+/*
+ * Handles managing product and pet categories.
+ *
+ * Author: Harkamal
+ * Date: April 2026
+ */
 package com.petshop.backend.controller;
 
 import com.petshop.backend.dto.category.CategoryRequest;
diff --git a/backend/src/main/java/com/petshop/backend/controller/ChatController.java b/backend/src/main/java/com/petshop/backend/controller/ChatController.java
index f1e26209..29fef9c1 100644
--- a/backend/src/main/java/com/petshop/backend/controller/ChatController.java
+++ b/backend/src/main/java/com/petshop/backend/controller/ChatController.java
@@ -1,3 +1,9 @@
+/*
+ * Handles chat conversations and messages between users.
+ *
+ * Author: Harkamal
+ * Date: April 2026
+ */
 package com.petshop.backend.controller;
 
 import com.petshop.backend.dto.chat.ConversationRequest;
diff --git a/backend/src/main/java/com/petshop/backend/controller/ChatWebSocketController.java b/backend/src/main/java/com/petshop/backend/controller/ChatWebSocketController.java
index 4bee487c..84274143 100644
--- a/backend/src/main/java/com/petshop/backend/controller/ChatWebSocketController.java
+++ b/backend/src/main/java/com/petshop/backend/controller/ChatWebSocketController.java
@@ -1,3 +1,9 @@
+/*
+ * Handles real-time chat messaging over WebSocket connections.
+ *
+ * Author: Harkamal
+ * Date: April 2026
+ */
 package com.petshop.backend.controller;
 
 import com.petshop.backend.config.WebSocketAuthChannelInterceptor;
diff --git a/backend/src/main/java/com/petshop/backend/controller/ContactController.java b/backend/src/main/java/com/petshop/backend/controller/ContactController.java
index cfd4326f..f91fa983 100644
--- a/backend/src/main/java/com/petshop/backend/controller/ContactController.java
+++ b/backend/src/main/java/com/petshop/backend/controller/ContactController.java
@@ -1,3 +1,9 @@
+/*
+ * Handles sending contact form messages from customers.
+ *
+ * Author: Harkamal
+ * Date: April 2026
+ */
 package com.petshop.backend.controller;
 
 import com.petshop.backend.entity.User;
diff --git a/backend/src/main/java/com/petshop/backend/controller/CouponController.java b/backend/src/main/java/com/petshop/backend/controller/CouponController.java
index 44fdbd04..a9ab098c 100644
--- a/backend/src/main/java/com/petshop/backend/controller/CouponController.java
+++ b/backend/src/main/java/com/petshop/backend/controller/CouponController.java
@@ -1,3 +1,9 @@
+/*
+ * Handles creating and managing discount coupons.
+ *
+ * Author: Harkamal
+ * Date: April 2026
+ */
 package com.petshop.backend.controller;
 
 import com.petshop.backend.dto.common.BulkDeleteRequest;
diff --git a/backend/src/main/java/com/petshop/backend/controller/CustomerController.java b/backend/src/main/java/com/petshop/backend/controller/CustomerController.java
index 534fc06e..4ed81357 100644
--- a/backend/src/main/java/com/petshop/backend/controller/CustomerController.java
+++ b/backend/src/main/java/com/petshop/backend/controller/CustomerController.java
@@ -1,3 +1,9 @@
+/*
+ * Handles staff and admin operations for managing customer accounts.
+ *
+ * Author: Harkamal
+ * Date: April 2026
+ */
 package com.petshop.backend.controller;
 
 import com.petshop.backend.dto.common.BulkDeleteRequest;
diff --git a/backend/src/main/java/com/petshop/backend/controller/DropdownController.java b/backend/src/main/java/com/petshop/backend/controller/DropdownController.java
index 756a9fca..0c7fe2ae 100644
--- a/backend/src/main/java/com/petshop/backend/controller/DropdownController.java
+++ b/backend/src/main/java/com/petshop/backend/controller/DropdownController.java
@@ -1,3 +1,9 @@
+/*
+ * Handles providing dropdown menu options for forms across the app.
+ *
+ * Author: Harkamal
+ * Date: April 2026
+ */
 package com.petshop.backend.controller;
 
 import com.petshop.backend.dto.common.DropdownOption;
diff --git a/backend/src/main/java/com/petshop/backend/controller/EmployeeController.java b/backend/src/main/java/com/petshop/backend/controller/EmployeeController.java
index 05cc8553..41a4b50d 100644
--- a/backend/src/main/java/com/petshop/backend/controller/EmployeeController.java
+++ b/backend/src/main/java/com/petshop/backend/controller/EmployeeController.java
@@ -1,3 +1,9 @@
+/*
+ * Handles admin operations for managing employee accounts.
+ *
+ * Author: Harkamal
+ * Date: April 2026
+ */
 package com.petshop.backend.controller;
 
 import com.petshop.backend.dto.user.UserRequest;
diff --git a/backend/src/main/java/com/petshop/backend/controller/HealthController.java b/backend/src/main/java/com/petshop/backend/controller/HealthController.java
index 8ee609c3..ce6729b9 100644
--- a/backend/src/main/java/com/petshop/backend/controller/HealthController.java
+++ b/backend/src/main/java/com/petshop/backend/controller/HealthController.java
@@ -1,3 +1,9 @@
+/*
+ * Handles health check requests to verify the server is running.
+ *
+ * Author: Harkamal
+ * Date: April 2026
+ */
 package com.petshop.backend.controller;
 
 import org.springframework.http.ResponseEntity;
diff --git a/backend/src/main/java/com/petshop/backend/controller/InventoryController.java b/backend/src/main/java/com/petshop/backend/controller/InventoryController.java
index f7aea48f..f6716e1d 100644
--- a/backend/src/main/java/com/petshop/backend/controller/InventoryController.java
+++ b/backend/src/main/java/com/petshop/backend/controller/InventoryController.java
@@ -1,3 +1,9 @@
+/*
+ * Handles tracking product stock levels across store locations.
+ *
+ * Author: Harkamal
+ * Date: April 2026
+ */
 package com.petshop.backend.controller;
 
 import com.petshop.backend.dto.common.BulkDeleteRequest;
diff --git a/backend/src/main/java/com/petshop/backend/controller/MyPetController.java b/backend/src/main/java/com/petshop/backend/controller/MyPetController.java
index 5d4ad1ef..e9f12262 100644
--- a/backend/src/main/java/com/petshop/backend/controller/MyPetController.java
+++ b/backend/src/main/java/com/petshop/backend/controller/MyPetController.java
@@ -1,3 +1,9 @@
+/*
+ * Handles customers viewing and managing their own pets.
+ *
+ * Author: Harkamal
+ * Date: April 2026
+ */
 package com.petshop.backend.controller;
 
 import com.petshop.backend.dto.pet.MyPetRequest;
diff --git a/backend/src/main/java/com/petshop/backend/controller/PetController.java b/backend/src/main/java/com/petshop/backend/controller/PetController.java
index a708a4db..d83841ae 100644
--- a/backend/src/main/java/com/petshop/backend/controller/PetController.java
+++ b/backend/src/main/java/com/petshop/backend/controller/PetController.java
@@ -1,3 +1,9 @@
+/*
+ * Handles managing pets available in the shop.
+ *
+ * Author: Harkamal
+ * Date: April 2026
+ */
 package com.petshop.backend.controller;
 
 import com.petshop.backend.dto.common.BulkDeleteRequest;
diff --git a/backend/src/main/java/com/petshop/backend/controller/PetImageController.java b/backend/src/main/java/com/petshop/backend/controller/PetImageController.java
index 2cd9845f..8442e060 100644
--- a/backend/src/main/java/com/petshop/backend/controller/PetImageController.java
+++ b/backend/src/main/java/com/petshop/backend/controller/PetImageController.java
@@ -1,3 +1,9 @@
+/*
+ * Handles uploading, retrieving, and deleting pet images.
+ *
+ * Author: Harkamal
+ * Date: April 2026
+ */
 package com.petshop.backend.controller;
 
 import com.petshop.backend.dto.pet.PetResponse;
diff --git a/backend/src/main/java/com/petshop/backend/controller/ProductController.java b/backend/src/main/java/com/petshop/backend/controller/ProductController.java
index 418d113a..acfc4fd4 100644
--- a/backend/src/main/java/com/petshop/backend/controller/ProductController.java
+++ b/backend/src/main/java/com/petshop/backend/controller/ProductController.java
@@ -1,3 +1,9 @@
+/*
+ * Handles creating, updating, and browsing products in the shop.
+ *
+ * Author: Harkamal
+ * Date: April 2026
+ */
 package com.petshop.backend.controller;
 
 import com.petshop.backend.dto.common.BulkDeleteRequest;
diff --git a/backend/src/main/java/com/petshop/backend/controller/ProductImageController.java b/backend/src/main/java/com/petshop/backend/controller/ProductImageController.java
index fb9ffa08..de19b1fc 100644
--- a/backend/src/main/java/com/petshop/backend/controller/ProductImageController.java
+++ b/backend/src/main/java/com/petshop/backend/controller/ProductImageController.java
@@ -1,3 +1,9 @@
+/*
+ * Handles uploading, retrieving, and deleting product images.
+ *
+ * Author: Harkamal
+ * Date: April 2026
+ */
 package com.petshop.backend.controller;
 
 import com.petshop.backend.dto.product.ProductResponse;
diff --git a/backend/src/main/java/com/petshop/backend/controller/ProductSupplierController.java b/backend/src/main/java/com/petshop/backend/controller/ProductSupplierController.java
index f521cb76..c9f3a844 100644
--- a/backend/src/main/java/com/petshop/backend/controller/ProductSupplierController.java
+++ b/backend/src/main/java/com/petshop/backend/controller/ProductSupplierController.java
@@ -1,3 +1,9 @@
+/*
+ * Handles linking products to their suppliers.
+ *
+ * Author: Harkamal
+ * Date: April 2026
+ */
 package com.petshop.backend.controller;
 
 import com.petshop.backend.dto.productsupplier.BulkDeleteProductSupplierRequest;
diff --git a/backend/src/main/java/com/petshop/backend/controller/PurchaseOrderController.java b/backend/src/main/java/com/petshop/backend/controller/PurchaseOrderController.java
index c73d9fcc..9386ce14 100644
--- a/backend/src/main/java/com/petshop/backend/controller/PurchaseOrderController.java
+++ b/backend/src/main/java/com/petshop/backend/controller/PurchaseOrderController.java
@@ -1,3 +1,9 @@
+/*
+ * Handles purchase orders for restocking products from suppliers.
+ *
+ * Author: Harkamal
+ * Date: April 2026
+ */
 package com.petshop.backend.controller;
 
 import com.petshop.backend.dto.purchaseorder.PurchaseOrderResponse;
diff --git a/backend/src/main/java/com/petshop/backend/controller/RefundController.java b/backend/src/main/java/com/petshop/backend/controller/RefundController.java
index b8e20241..399099de 100644
--- a/backend/src/main/java/com/petshop/backend/controller/RefundController.java
+++ b/backend/src/main/java/com/petshop/backend/controller/RefundController.java
@@ -1,3 +1,9 @@
+/*
+ * Handles requesting and processing refunds for orders.
+ *
+ * Author: Harkamal
+ * Date: April 2026
+ */
 package com.petshop.backend.controller;
 
 import com.petshop.backend.dto.refund.RefundRequest;
diff --git a/backend/src/main/java/com/petshop/backend/controller/SaleController.java b/backend/src/main/java/com/petshop/backend/controller/SaleController.java
index bc40b066..36039046 100644
--- a/backend/src/main/java/com/petshop/backend/controller/SaleController.java
+++ b/backend/src/main/java/com/petshop/backend/controller/SaleController.java
@@ -1,3 +1,9 @@
+/*
+ * Handles creating and viewing sales and customer orders.
+ *
+ * Author: Harkamal
+ * Date: April 2026
+ */
 package com.petshop.backend.controller;
 
 import com.petshop.backend.dto.sale.SaleRequest;
diff --git a/backend/src/main/java/com/petshop/backend/controller/ServiceController.java b/backend/src/main/java/com/petshop/backend/controller/ServiceController.java
index 4789321a..3b42e11e 100644
--- a/backend/src/main/java/com/petshop/backend/controller/ServiceController.java
+++ b/backend/src/main/java/com/petshop/backend/controller/ServiceController.java
@@ -1,3 +1,9 @@
+/*
+ * Handles managing pet services like grooming and veterinary care.
+ *
+ * Author: Harkamal
+ * Date: April 2026
+ */
 package com.petshop.backend.controller;
 
 import com.petshop.backend.dto.common.BulkDeleteRequest;
diff --git a/backend/src/main/java/com/petshop/backend/controller/StoreController.java b/backend/src/main/java/com/petshop/backend/controller/StoreController.java
index dc7bf8f5..2984597e 100644
--- a/backend/src/main/java/com/petshop/backend/controller/StoreController.java
+++ b/backend/src/main/java/com/petshop/backend/controller/StoreController.java
@@ -1,3 +1,9 @@
+/*
+ * Handles managing store locations for the pet shop.
+ *
+ * Author: Harkamal
+ * Date: April 2026
+ */
 package com.petshop.backend.controller;
 
 import com.petshop.backend.dto.common.BulkDeleteRequest;
diff --git a/backend/src/main/java/com/petshop/backend/controller/SupplierController.java b/backend/src/main/java/com/petshop/backend/controller/SupplierController.java
index eb5c065d..9c0ff083 100644
--- a/backend/src/main/java/com/petshop/backend/controller/SupplierController.java
+++ b/backend/src/main/java/com/petshop/backend/controller/SupplierController.java
@@ -1,3 +1,9 @@
+/*
+ * Handles managing suppliers who provide products to the shop.
+ *
+ * Author: Harkamal
+ * Date: April 2026
+ */
 package com.petshop.backend.controller;
 
 import com.petshop.backend.dto.common.BulkDeleteRequest;
diff --git a/backend/src/main/java/com/petshop/backend/controller/UserAvatarController.java b/backend/src/main/java/com/petshop/backend/controller/UserAvatarController.java
index ac7d146c..df453194 100644
--- a/backend/src/main/java/com/petshop/backend/controller/UserAvatarController.java
+++ b/backend/src/main/java/com/petshop/backend/controller/UserAvatarController.java
@@ -1,3 +1,9 @@
+/*
+ * Handles uploading, retrieving, and deleting user profile pictures.
+ *
+ * Author: Harkamal
+ * Date: April 2026
+ */
 package com.petshop.backend.controller;
 
 import com.petshop.backend.entity.User;
diff --git a/backend/src/main/java/com/petshop/backend/controller/UserController.java b/backend/src/main/java/com/petshop/backend/controller/UserController.java
index 28ef9f9e..ec28f50c 100644
--- a/backend/src/main/java/com/petshop/backend/controller/UserController.java
+++ b/backend/src/main/java/com/petshop/backend/controller/UserController.java
@@ -1,3 +1,9 @@
+/*
+ * Handles admin operations for managing all user accounts.
+ *
+ * Author: Harkamal
+ * Date: April 2026
+ */
 package com.petshop.backend.controller;
 
 import com.petshop.backend.dto.common.BulkDeleteRequest;