From e8d6c99089ca6da69f17e43dc3b7461b9f3b31b4 Mon Sep 17 00:00:00 2001
From: Chneemann <andre-kempf@mailbox.org>
Date: Tue, 12 Nov 2024 04:44:36 +0100
Subject: [PATCH] docs: add JSDoc comments to ButtonsComponent

---
 .../components/buttons/btn-back/btn-back.component.ts       | 3 +++
 .../components/buttons/btn-close/btn-close.component.ts     | 6 ++++++
 2 files changed, 9 insertions(+)

diff --git a/src/app/shared/components/buttons/btn-back/btn-back.component.ts b/src/app/shared/components/buttons/btn-back/btn-back.component.ts
index b48e2f9..4a69e3c 100644
--- a/src/app/shared/components/buttons/btn-back/btn-back.component.ts
+++ b/src/app/shared/components/buttons/btn-back/btn-back.component.ts
@@ -12,6 +12,9 @@ import { Location } from '@angular/common';
 export class BtnBackComponent {
   constructor(private location: Location) {}
 
+  /**
+   * Navigates back in the browser's history.
+   */
   backClicked() {
     this.location.back();
   }
diff --git a/src/app/shared/components/buttons/btn-close/btn-close.component.ts b/src/app/shared/components/buttons/btn-close/btn-close.component.ts
index 91fc3e6..440bf43 100644
--- a/src/app/shared/components/buttons/btn-close/btn-close.component.ts
+++ b/src/app/shared/components/buttons/btn-close/btn-close.component.ts
@@ -13,6 +13,12 @@ export class BtnCloseComponent {
 
   constructor(private sharedService: SharedService) {}
 
+  /**
+   * Called when the close button is clicked.
+   * Sets isAnyDialogOpen to false and sets
+   * isEditContactDialogOpen and isNewContactDialogOpen
+   * to the value of isContactDialogOpen.
+   */
   closeClicked() {
     this.sharedService.isAnyDialogOpen = false;
     this.sharedService.isEditContactDialogOpen = this.isContactDialogOpen;