mirror of
https://github.com/DSpace/dspace-angular.git
synced 2025-10-07 01:54:15 +00:00
99053: Added missing documentation
This commit is contained in:
@@ -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;
|
||||
|
@@ -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',
|
||||
|
@@ -1,8 +0,0 @@
|
||||
import { Component } from '@angular/core';
|
||||
|
||||
@Component({
|
||||
selector: 'ds-advanced-workflow-action-abstract',
|
||||
template: '',
|
||||
})
|
||||
export abstract class AdvancedWorkflowActionAbstractComponent {
|
||||
}
|
@@ -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',
|
||||
|
Reference in New Issue
Block a user