99053: Added missing documentation

This commit is contained in:
Alexandre Vryghem
2023-02-06 22:53:50 +01:00
parent 1b4bdba52d
commit 4cc98ae7be
4 changed files with 22 additions and 12 deletions

View File

@@ -37,12 +37,30 @@ enum SubKey {
SearchResultsDTO, SearchResultsDTO,
} }
/**
* The layout config of the buttons in the last column
*/
export interface EPersonActionConfig { export interface EPersonActionConfig {
/**
* The css classes that should be added to the button
*/
css?: string; css?: string;
/**
* Whether the button should be disabled
*/
disabled: boolean; disabled: boolean;
/**
* The Font Awesome icon that should be used
*/
icon: string; 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 { export interface EPersonListActionConfig {
add: EPersonActionConfig; add: EPersonActionConfig;
remove: EPersonActionConfig; remove: EPersonActionConfig;

View File

@@ -7,8 +7,8 @@ import { getAdvancedWorkflowRoute } from '../../../../workflowitems-edit-page/wo
/** /**
* Abstract component for rendering an advanced claimed task's action * Abstract component for rendering an advanced claimed task's action
* To create a child-component for a new option: * To create a child-component for a new option:
* - Set the "option" and "workflowType" of the component * - Set the "{@link option}" and "{@link workflowType}" of the component
* - Add a @rendersWorkflowTaskOption annotation to your component providing the same enum value * - Add a @{@link rendersWorkflowTaskOption} annotation to your component providing the same enum value
*/ */
@Component({ @Component({
selector: 'ds-advanced-claimed-task-action-abstract', selector: 'ds-advanced-claimed-task-action-abstract',

View File

@@ -1,8 +0,0 @@
import { Component } from '@angular/core';
@Component({
selector: 'ds-advanced-workflow-action-abstract',
template: '',
})
export abstract class AdvancedWorkflowActionAbstractComponent {
}

View File

@@ -17,8 +17,8 @@ import { RequestService } from '../../../core/data/request.service';
/** /**
* Abstract component for rendering an advanced claimed task's workflow page * Abstract component for rendering an advanced claimed task's workflow page
* To create a child-component for a new option: * To create a child-component for a new option:
* - Set the "getType()" of the component * - Set the "{@link getType}()" of the component
* - Implement the createBody, should always contain at least the ADVANCED_WORKFLOW_TASK_OPTION * - Implement the {@link createBody}, should always contain at least the ADVANCED_WORKFLOW_TASK_OPTION_*
*/ */
@Component({ @Component({
selector: 'ds-advanced-workflow-action', selector: 'ds-advanced-workflow-action',