add JavaDoc

ls1intum · Feb 18, 2025 · c055160 · c055160
1 parent d01a94a
commit c055160
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/src/main/java/de/tum/cit/aet/artemis/communication/service/PostingService.java b/src/main/java/de/tum/cit/aet/artemis/communication/service/PostingService.java
@@ -197,6 +197,12 @@ protected Course preCheckUserAndCourseForMessaging(User user, Long courseId) {
         return course;
     }
 
+    /**
+     * Ensures that user is allowed to communicate or message in the given course
+     *
+     * @param user   that wants to communicate or message
+     * @param course the course in which the user wants to communicate or message
+     */
     public void preCheckUserAndCourseForCommunicationOrMessaging(User user, Course course) {
         authorizationCheckService.checkHasAtLeastRoleInCourseElseThrow(Role.STUDENT, course, user);