Added file header comments

usd-cs · Feb 27, 2025 · 57e0276 · 57e0276
1 parent d15250d
commit 57e0276
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/backend/src/main/java/COMP_49X_our_search/backend/profile/ProfileRetriever.java b/backend/src/main/java/COMP_49X_our_search/backend/profile/ProfileRetriever.java
@@ -1,3 +1,9 @@
+/**
+ * Interface for Profile retrieval. Defines a method for retrieving a user's
+ * profile by email.
+ *
+ * @author Augusto Escudero
+ */
 package COMP_49X_our_search.backend.profile;
 
 import proto.profile.ProfileModule.RetrieveProfileRequest;

diff --git a/backend/src/main/java/COMP_49X_our_search/backend/profile/StudentProfileRetriever.java b/backend/src/main/java/COMP_49X_our_search/backend/profile/StudentProfileRetriever.java
@@ -1,3 +1,11 @@
+/**
+ * Profile retriever for students. This class handles the retrieval of student
+ * profiles by querying the database using the user's email.
+ *
+ * Implements the ProfileRetriever interface.
+ *
+ * @author Augusto Escudero
+ */
 package COMP_49X_our_search.backend.profile;
 
 import static COMP_49X_our_search.backend.util.ProtoConverter.toStudentProto;