From 4cc98ae7bec43c3eb64161a7b6a312e8cafe8a1d Mon Sep 17 00:00:00 2001
From: Alexandre Vryghem <alexandre@atmire.com>
Date: Mon, 6 Feb 2023 22:53:50 +0100
Subject: [PATCH] 99053: Added missing documentation

---
 .../members-list/members-list.component.ts     | 18 ++++++++++++++++++
 ...-claimed-task-actions-abstract.component.ts |  4 ++--
 ...anced-workflow-action-abstract.component.ts |  8 --------
 .../advanced-workflow-action.component.ts      |  4 ++--
 4 files changed, 22 insertions(+), 12 deletions(-)
 delete mode 100644 src/app/shared/mydspace-actions/claimed-task/abstract/advanced-workflow-action-abstract.component.ts

diff --git a/src/app/access-control/group-registry/group-form/members-list/members-list.component.ts b/src/app/access-control/group-registry/group-form/members-list/members-list.component.ts
index bdeb49decd..8d2b13aae6 100644
--- a/src/app/access-control/group-registry/group-form/members-list/members-list.component.ts
+++ b/src/app/access-control/group-registry/group-form/members-list/members-list.component.ts
@@ -37,12 +37,30 @@ enum SubKey {
   SearchResultsDTO,
 }
 
+/**
+ * The layout config of the buttons in the last column
+ */
 export interface EPersonActionConfig {
+  /**
+   * The css classes that should be added to the button
+   */
   css?: string;
+  /**
+   * Whether the button should be disabled
+   */
   disabled: boolean;
+  /**
+   * The Font Awesome icon that should be used
+   */
   icon: string;
 }
 
+/**
+ * The {@link EPersonActionConfig} that should be used to display the button. The remove config will be used when the
+ * {@link EPerson} is already a member of the {@link Group} and the remove config will be used otherwise.
+ *
+ * *See {@link actionConfig} for an example*
+ */
 export interface EPersonListActionConfig {
   add: EPersonActionConfig;
   remove: EPersonActionConfig;
diff --git a/src/app/shared/mydspace-actions/claimed-task/abstract/advanced-claimed-task-actions-abstract.component.ts b/src/app/shared/mydspace-actions/claimed-task/abstract/advanced-claimed-task-actions-abstract.component.ts
index d3f2ce4b6e..06d51d67a3 100644
--- a/src/app/shared/mydspace-actions/claimed-task/abstract/advanced-claimed-task-actions-abstract.component.ts
+++ b/src/app/shared/mydspace-actions/claimed-task/abstract/advanced-claimed-task-actions-abstract.component.ts
@@ -7,8 +7,8 @@ import { getAdvancedWorkflowRoute } from '../../../../workflowitems-edit-page/wo
 /**
  * Abstract component for rendering an advanced claimed task's action
  * To create a child-component for a new option:
- * - Set the "option" and "workflowType" of the component
- * - Add a @rendersWorkflowTaskOption annotation to your component providing the same enum value
+ * - Set the "{@link option}" and "{@link workflowType}" of the component
+ * - Add a @{@link rendersWorkflowTaskOption} annotation to your component providing the same enum value
  */
 @Component({
   selector: 'ds-advanced-claimed-task-action-abstract',
diff --git a/src/app/shared/mydspace-actions/claimed-task/abstract/advanced-workflow-action-abstract.component.ts b/src/app/shared/mydspace-actions/claimed-task/abstract/advanced-workflow-action-abstract.component.ts
deleted file mode 100644
index be6935d900..0000000000
--- a/src/app/shared/mydspace-actions/claimed-task/abstract/advanced-workflow-action-abstract.component.ts
+++ /dev/null
@@ -1,8 +0,0 @@
-import { Component } from '@angular/core';
-
-@Component({
-  selector: 'ds-advanced-workflow-action-abstract',
-  template: '',
-})
-export abstract class AdvancedWorkflowActionAbstractComponent {
-}
diff --git a/src/app/workflowitems-edit-page/advanced-workflow-action/advanced-workflow-action/advanced-workflow-action.component.ts b/src/app/workflowitems-edit-page/advanced-workflow-action/advanced-workflow-action/advanced-workflow-action.component.ts
index 61bc60cdbd..5621e56578 100644
--- a/src/app/workflowitems-edit-page/advanced-workflow-action/advanced-workflow-action/advanced-workflow-action.component.ts
+++ b/src/app/workflowitems-edit-page/advanced-workflow-action/advanced-workflow-action/advanced-workflow-action.component.ts
@@ -17,8 +17,8 @@ import { RequestService } from '../../../core/data/request.service';
 /**
  * Abstract component for rendering an advanced claimed task's workflow page
  * To create a child-component for a new option:
- * - Set the "getType()" of the component
- * - Implement the createBody, should always contain at least the ADVANCED_WORKFLOW_TASK_OPTION
+ * - Set the "{@link getType}()" of the component
+ * - Implement the {@link createBody}, should always contain at least the ADVANCED_WORKFLOW_TASK_OPTION_*
  */
 @Component({
   selector: 'ds-advanced-workflow-action',