From 78d5116cdb7d1d6afaef8d8b9e35b792b551e03d Mon Sep 17 00:00:00 2001 From: Nona Luypaert Date: Tue, 23 May 2023 17:54:33 +0200 Subject: [PATCH] 101623: Add missing docs + Fix lint issues --- src/app/browse-by/browse-by-routing.module.ts | 2 -- src/app/core/data/browse-response-parsing.service.ts | 2 +- src/app/core/data/request.models.ts | 3 +++ src/app/core/shared/flat-browse-definition.model.ts | 3 +++ src/app/core/shared/hierarchical-browse-definition.model.ts | 3 +++ src/app/core/shared/value-list-browse-definition.model.ts | 3 +++ .../form/vocabulary-treeview/vocabulary-treeview.component.ts | 2 +- 7 files changed, 14 insertions(+), 4 deletions(-) diff --git a/src/app/browse-by/browse-by-routing.module.ts b/src/app/browse-by/browse-by-routing.module.ts index 5d3697f391..5788d3cc70 100644 --- a/src/app/browse-by/browse-by-routing.module.ts +++ b/src/app/browse-by/browse-by-routing.module.ts @@ -4,8 +4,6 @@ import { BrowseByGuard } from './browse-by-guard'; import { BrowseByDSOBreadcrumbResolver } from './browse-by-dso-breadcrumb.resolver'; import { BrowseByI18nBreadcrumbResolver } from './browse-by-i18n-breadcrumb.resolver'; import { ThemedBrowseBySwitcherComponent } from './browse-by-switcher/themed-browse-by-switcher.component'; -import { ThemedBrowseByTaxonomyPageComponent } from './browse-by-taxonomy-page/themed-browse-by-taxonomy-page.component'; -import { I18nBreadcrumbResolver } from '../core/breadcrumbs/i18n-breadcrumb.resolver'; @NgModule({ imports: [ diff --git a/src/app/core/data/browse-response-parsing.service.ts b/src/app/core/data/browse-response-parsing.service.ts index 3681198406..a568cdb617 100644 --- a/src/app/core/data/browse-response-parsing.service.ts +++ b/src/app/core/data/browse-response-parsing.service.ts @@ -15,7 +15,7 @@ import { ValueListBrowseDefinition } from '../shared/value-list-browse-definitio import { VALUE_LIST_BROWSE_DEFINITION } from '../shared/value-list-browse-definition.resource-type'; /** - * A ResponseParsingService used to parse RawRestResponse coming from the REST API to a BrowseDefinition object + * A ResponseParsingService used to parse a REST API response to a BrowseDefinition object */ @Injectable({ providedIn: 'root', diff --git a/src/app/core/data/request.models.ts b/src/app/core/data/request.models.ts index 79505a3dee..9809bc0fde 100644 --- a/src/app/core/data/request.models.ts +++ b/src/app/core/data/request.models.ts @@ -119,6 +119,9 @@ export class PatchRequest extends DSpaceRestRequest { } } +/** + * Class representing a BrowseDefinition HTTP Rest request object + */ export class BrowseDefinitionRestRequest extends DSpaceRestRequest { getResponseParser(): GenericConstructor { return BrowseResponseParsingService; diff --git a/src/app/core/shared/flat-browse-definition.model.ts b/src/app/core/shared/flat-browse-definition.model.ts index f94fa75b91..308f0c7a5b 100644 --- a/src/app/core/shared/flat-browse-definition.model.ts +++ b/src/app/core/shared/flat-browse-definition.model.ts @@ -5,6 +5,9 @@ import { FLAT_BROWSE_DEFINITION } from './flat-browse-definition.resource-type'; import { ResourceType } from './resource-type'; import { NonHierarchicalBrowseDefinition } from './non-hierarchical-browse-definition'; +/** + * BrowseDefinition model for browses of type 'flatBrowse' + */ @typedObject @inheritSerialization(NonHierarchicalBrowseDefinition) export class FlatBrowseDefinition extends NonHierarchicalBrowseDefinition { diff --git a/src/app/core/shared/hierarchical-browse-definition.model.ts b/src/app/core/shared/hierarchical-browse-definition.model.ts index 427f5e1947..ca3ed7bff0 100644 --- a/src/app/core/shared/hierarchical-browse-definition.model.ts +++ b/src/app/core/shared/hierarchical-browse-definition.model.ts @@ -6,6 +6,9 @@ import { HALLink } from './hal-link.model'; import { ResourceType } from './resource-type'; import { BrowseDefinition } from './browse-definition.model'; +/** + * BrowseDefinition model for browses of type 'hierarchicalBrowse' + */ @typedObject @inheritSerialization(BrowseDefinition) export class HierarchicalBrowseDefinition extends BrowseDefinition { diff --git a/src/app/core/shared/value-list-browse-definition.model.ts b/src/app/core/shared/value-list-browse-definition.model.ts index a42a702940..33cce82cac 100644 --- a/src/app/core/shared/value-list-browse-definition.model.ts +++ b/src/app/core/shared/value-list-browse-definition.model.ts @@ -5,6 +5,9 @@ import { VALUE_LIST_BROWSE_DEFINITION } from './value-list-browse-definition.res import { ResourceType } from './resource-type'; import { NonHierarchicalBrowseDefinition } from './non-hierarchical-browse-definition'; +/** + * BrowseDefinition model for browses of type 'valueList' + */ @typedObject @inheritSerialization(NonHierarchicalBrowseDefinition) export class ValueListBrowseDefinition extends NonHierarchicalBrowseDefinition { diff --git a/src/app/shared/form/vocabulary-treeview/vocabulary-treeview.component.ts b/src/app/shared/form/vocabulary-treeview/vocabulary-treeview.component.ts index 2199de920e..891a825745 100644 --- a/src/app/shared/form/vocabulary-treeview/vocabulary-treeview.component.ts +++ b/src/app/shared/form/vocabulary-treeview/vocabulary-treeview.component.ts @@ -248,7 +248,7 @@ export class VocabularyTreeviewComponent implements OnDestroy, OnInit { } /** - * Method called on entry select + * Method called on entry select/deselect */ onSelect(item: VocabularyEntryDetail) { if (!this.selectedItems.includes(item.id)) {