#2074-javadocs

src/backend/src/services/announcement.service.ts

@@ -4,6 +4,18 @@ import { getAnnouncementQueryArgs } from '../prisma-query-args/announcements.que
 import announcementTransformer from '../transformers/announcements.transformer';
 
 export default class AnnouncementService {
+  /**
+   * Creates an announcement that is sent to users
+   * this data is populated from slack events
+   * @param text slack message text
+   * @param usersReceivedIds users to send announcements to
+   * @param dateCreated date created of slack message
+   * @param senderName name of user who sent slack message
+   * @param slackEventId id of slack event (provided by slack api)
+   * @param slackChannelName name of channel message was sent in
+   * @param organizationId id of organization of users
+   * @returns the created announcement
+   */
   static async createAnnouncement(
     text: string,
     usersReceivedIds: string[],