From 33026ba3e0201703bf0eedc9d3f0297828acc985 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Wolfgang=20Hu=C3=9F?= <wolle.huss@pjannto.com>
Date: Tue, 2 Aug 2022 08:30:54 +0200
Subject: [PATCH] Add explaining comments to confirmation modal

---
 webapp/components/Modal.vue              | 2 ++
 webapp/components/Modal/ConfirmModal.vue | 6 +++---
 2 files changed, 5 insertions(+), 3 deletions(-)

diff --git a/webapp/components/Modal.vue b/webapp/components/Modal.vue
index a76adac3f..9195ad179 100644
--- a/webapp/components/Modal.vue
+++ b/webapp/components/Modal.vue
@@ -22,6 +22,7 @@
       :name="name"
       @close="close"
     />
+    <!-- "id", "type", and "name" props are only used for compatibility with the other modals -->
     <confirm-modal
       v-if="open === 'confirm'"
       :id="data.resource.id"
@@ -57,6 +58,7 @@ export default {
       open: 'modal/open',
     }),
     name() {
+      // REFACTORING: This gets unneccesary if we use "modalData" in all modals by probaply replacing them all by "confirm-modal"
       if (!this.data || !this.data.resource) return ''
       const {
         resource: { name, title, author },
diff --git a/webapp/components/Modal/ConfirmModal.vue b/webapp/components/Modal/ConfirmModal.vue
index 9eb81b5ea..87dc4963a 100644
--- a/webapp/components/Modal/ConfirmModal.vue
+++ b/webapp/components/Modal/ConfirmModal.vue
@@ -41,10 +41,10 @@ export default {
     SweetalertIcon,
   },
   props: {
-    name: { type: String, default: '' },
-    type: { type: String, required: true },
+    name: { type: String, default: '' }, // only used for compatibility with the other modals in 'Modal.vue'
+    type: { type: String, required: true }, // only used for compatibility with the other modals in 'Modal.vue'
     modalData: { type: Object, required: true },
-    id: { type: String, required: true },
+    id: { type: String, required: true }, // only used for compatibility with the other modals in 'Modal.vue'
   },
   data() {
     return {