From 751d689ff65b15fa4f8b2f898d43ecaa682e8085 Mon Sep 17 00:00:00 2001
From: Andreas Awouters <andreas.awouters@atmire.com>
Date: Fri, 27 Sep 2024 10:02:26 +0200
Subject: [PATCH] 118220: Add additional TypeDocs

---
 src/app/shared/live-region/live-region.component.ts | 6 ++++++
 src/app/shared/live-region/live-region.service.ts   | 5 ++++-
 2 files changed, 10 insertions(+), 1 deletion(-)

diff --git a/src/app/shared/live-region/live-region.component.ts b/src/app/shared/live-region/live-region.component.ts
index d7bd5eb806c..8a25c4657ca 100644
--- a/src/app/shared/live-region/live-region.component.ts
+++ b/src/app/shared/live-region/live-region.component.ts
@@ -2,6 +2,12 @@ import { Component, OnInit } from '@angular/core';
 import { LiveRegionService } from './live-region.service';
 import { Observable } from 'rxjs';
 
+/**
+ * The Live Region Component is an accessibility tool for screenreaders. When a change occurs on a page when the changed
+ * section is not in focus, a message should be displayed by this component so it can be announced by a screen reader.
+ *
+ * This component should not be used directly. Use the {@link LiveRegionService} to add messages.
+ */
 @Component({
   selector: `ds-live-region`,
   templateUrl: './live-region.component.html',
diff --git a/src/app/shared/live-region/live-region.service.ts b/src/app/shared/live-region/live-region.service.ts
index d89d72a9675..72940c1a0eb 100644
--- a/src/app/shared/live-region/live-region.service.ts
+++ b/src/app/shared/live-region/live-region.service.ts
@@ -3,6 +3,10 @@ import { BehaviorSubject } from 'rxjs';
 import { environment } from '../../../environments/environment';
 import { UUIDService } from '../../core/shared/uuid.service';
 
+/**
+ * The LiveRegionService is responsible for handling the messages that are shown by the {@link LiveRegionComponent}.
+ * Use this service to add or remove messages to the Live Region.
+ */
 @Injectable({
   providedIn: 'root',
 })
@@ -76,7 +80,6 @@ export class LiveRegionService {
   /**
    * Removes the message with the given UUID from the messages array
    * @param uuid The uuid of the message to clear
-   * @protected
    */
   clearMessageByUUID(uuid: string) {
     const index = this.messages.findIndex(messageObj => messageObj.uuid === uuid);