Skip to content

Commit 41ac417

Browse files
119915: Added additional docs
1 parent a947e8c commit 41ac417

4 files changed

Lines changed: 19 additions & 2 deletions

File tree

src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-value-field/abstract-dso-edit-metadata-value-field.component.ts

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,18 @@ import { DSpaceObject } from '../../../core/shared/dspace-object.model';
1010
import { DsoEditMetadataValue } from '../dso-edit-metadata-form';
1111
import { EditMetadataValueFieldType } from './dso-edit-metadata-field-type.enum';
1212

13+
/**
14+
* Abstract base component for editing metadata fields.
15+
*
16+
* This abstract component is only designed to contain the common `@Input()` & `@Output()` fields, that the
17+
* {@link DsoEditMetadataValueFieldLoaderComponent} passes to its dynamically generated components. This class should
18+
* not contain any methods or any other type of logic. Such logic should instead be created in
19+
* {@link DsoEditMetadataFieldService}.
20+
*/
1321
@Component({
14-
selector: 'ds-dso-edit-metadata-entity-field',
22+
selector: 'ds-abstract-dso-edit-metadata-value-field',
1523
template: '',
24+
standalone: true,
1625
})
1726
export abstract class AbstractDsoEditMetadataValueFieldComponent {
1827

src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-value-field/dso-edit-metadata-field.service.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@ import { VocabularyService } from '../../../core/submission/vocabularies/vocabul
1515
import { isNotEmpty } from '../../../shared/empty.util';
1616
import { followLink } from '../../../shared/utils/follow-link-config.model';
1717

18+
/**
19+
* A service containing all the common logic for the components generated by the
20+
* {@link DsoEditMetadataValueFieldLoaderComponent}.
21+
*/
1822
@Injectable({
1923
providedIn: 'root',
2024
})

src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-value-field/dso-edit-metadata-value-field-loader/dso-edit-metadata-value-field-loader.component.html

Lines changed: 0 additions & 1 deletion
This file was deleted.

src/app/dso-shared/dso-edit-metadata/dso-edit-metadata-value-field/dso-edit-metadata-value-field-loader/dso-edit-metadata-value-field-loader.component.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@ import { DsoEditMetadataValue } from '../../dso-edit-metadata-form';
1414
import { EditMetadataValueFieldType } from '../dso-edit-metadata-field-type.enum';
1515
import { getDsoEditMetadataValueFieldComponent } from './dso-edit-metadata-value-field.decorator';
1616

17+
/**
18+
* A component responsible for dynamically loading and rendering the appropriate edit metadata value field components
19+
* based on the type of the metadata field ({@link EditMetadataValueFieldType}) and the place where it's used
20+
* ({@link Context}).
21+
*/
1722
@Component({
1823
selector: 'ds-dso-edit-metadata-value-field-loader',
1924
templateUrl: '../../../../shared/abstract-component-loader/abstract-component-loader.component.html',

0 commit comments

Comments
 (0)