[DURACOM-191] add deprecated in jsdocs for decorators

src/app/access-control/access-control.module.ts

@@ -15,7 +15,6 @@ import { NgbAccordionModule } from '@ng-bootstrap/ng-bootstrap';
 import { BulkAccessBrowseComponent } from './bulk-access/browse/bulk-access-browse.component';
 import { BulkAccessSettingsComponent } from './bulk-access/settings/bulk-access-settings.component';
 import { SearchModule } from '../shared/search/search.module';
-import { AccessControlFormModule } from '../shared/access-control-form-container/access-control-form.module';
 
 /**
  * Condition for displaying error messages on email form field
@@ -32,7 +31,6 @@ export const ValidateEmailErrorStateMatcher: DynamicErrorMessagesMatcher =
         FormModule,
         NgbAccordionModule,
         SearchModule,
-        AccessControlFormModule,
         EPeopleRegistryComponent,
         EPersonFormComponent,
         GroupsRegistryComponent,

src/app/browse-by/browse-by-switcher/browse-by-decorator.ts

@@ -40,6 +40,7 @@ export const BROWSE_BY_DECORATOR_MAP =
  * Decorator used for rendering Browse-By pages by type
  * @param browseByType  The type of page
  * @param theme The optional theme for the component
+ * @deprecated
  */
 export function rendersBrowseBy(browseByType: BrowseByDataType, theme = DEFAULT_THEME) {
   return function decorator(component: any) {

src/app/collection-page/collection-page.module.ts

@@ -16,7 +16,6 @@ import { StatisticsModule } from '../statistics/statistics.module';
 import { CollectionFormModule } from './collection-form/collection-form.module';
 import { ThemedCollectionPageComponent } from './themed-collection-page.component';
 import { ComcolModule } from '../shared/comcol/comcol.module';
-import { DsoSharedModule } from '../dso-shared/dso-shared.module';
 import { DsoPageModule } from '../shared/dso-page/dso-page.module';
 
 @NgModule({
@@ -26,7 +25,6 @@ import { DsoPageModule } from '../shared/dso-page/dso-page.module';
     EditItemPageModule,
     CollectionFormModule,
     ComcolModule,
-        DsoSharedModule,
     DsoPageModule,
     CollectionPageComponent,
     ThemedCollectionPageComponent,

src/app/dso-shared/dso-shared.module.ts

@@ -1,32 +0,0 @@
-import { NgModule } from '@angular/core';
-import { DsoEditMetadataComponent } from './dso-edit-metadata/dso-edit-metadata.component';
-import { MetadataFieldSelectorComponent } from './dso-edit-metadata/metadata-field-selector/metadata-field-selector.component';
-import { DsoEditMetadataFieldValuesComponent } from './dso-edit-metadata/dso-edit-metadata-field-values/dso-edit-metadata-field-values.component';
-import { DsoEditMetadataValueComponent } from './dso-edit-metadata/dso-edit-metadata-value/dso-edit-metadata-value.component';
-import { DsoEditMetadataHeadersComponent } from './dso-edit-metadata/dso-edit-metadata-headers/dso-edit-metadata-headers.component';
-import { DsoEditMetadataValueHeadersComponent } from './dso-edit-metadata/dso-edit-metadata-value-headers/dso-edit-metadata-value-headers.component';
-import { ThemedDsoEditMetadataComponent } from './dso-edit-metadata/themed-dso-edit-metadata.component';
-
-@NgModule({
-    imports: [
-        DsoEditMetadataComponent,
-        ThemedDsoEditMetadataComponent,
-        MetadataFieldSelectorComponent,
-        DsoEditMetadataFieldValuesComponent,
-        DsoEditMetadataValueComponent,
-        DsoEditMetadataHeadersComponent,
-        DsoEditMetadataValueHeadersComponent
-    ],
-    exports: [
-        DsoEditMetadataComponent,
-        ThemedDsoEditMetadataComponent,
-        MetadataFieldSelectorComponent,
-        DsoEditMetadataFieldValuesComponent,
-        DsoEditMetadataValueComponent,
-        DsoEditMetadataHeadersComponent,
-        DsoEditMetadataValueHeadersComponent,
-    ]
-})
-export class DsoSharedModule {
-
-}

src/app/item-page/edit-item-page/edit-item-page.module.ts

@@ -1,7 +1,7 @@
 import { NgModule } from '@angular/core';
 import { CommonModule } from '@angular/common';
 
-import { NgbTooltipModule, NgbModule } from '@ng-bootstrap/ng-bootstrap';
+import { NgbModule, NgbTooltipModule } from '@ng-bootstrap/ng-bootstrap';
 
 import { EditItemPageComponent } from './edit-item-page.component';
 import { ItemStatusComponent } from './item-status/item-status.component';
@@ -18,14 +18,22 @@ import { SearchPageModule } from '../../search-page/search-page.module';
 import { ItemCollectionMapperComponent } from './item-collection-mapper/item-collection-mapper.component';
 import { ItemRelationshipsComponent } from './item-relationships/item-relationships.component';
 import { EditRelationshipComponent } from './item-relationships/edit-relationship/edit-relationship.component';
-import { EditRelationshipListComponent } from './item-relationships/edit-relationship-list/edit-relationship-list.component';
+import {
+  EditRelationshipListComponent
+} from './item-relationships/edit-relationship-list/edit-relationship-list.component';
 import { AbstractItemUpdateComponent } from './abstract-item-update/abstract-item-update.component';
 import { ItemMoveComponent } from './item-move/item-move.component';
-import { ItemEditBitstreamBundleComponent } from './item-bitstreams/item-edit-bitstream-bundle/item-edit-bitstream-bundle.component';
+import {
+  ItemEditBitstreamBundleComponent
+} from './item-bitstreams/item-edit-bitstream-bundle/item-edit-bitstream-bundle.component';
 import { BundleDataService } from '../../core/data/bundle-data.service';
 import { DragDropModule } from '@angular/cdk/drag-drop';
-import { ItemEditBitstreamDragHandleComponent } from './item-bitstreams/item-edit-bitstream-drag-handle/item-edit-bitstream-drag-handle.component';
-import { PaginatedDragAndDropBitstreamListComponent } from './item-bitstreams/item-edit-bitstream-bundle/paginated-drag-and-drop-bitstream-list/paginated-drag-and-drop-bitstream-list.component';
+import {
+  ItemEditBitstreamDragHandleComponent
+} from './item-bitstreams/item-edit-bitstream-drag-handle/item-edit-bitstream-drag-handle.component';
+import {
+  PaginatedDragAndDropBitstreamListComponent
+} from './item-bitstreams/item-edit-bitstream-bundle/paginated-drag-and-drop-bitstream-list/paginated-drag-and-drop-bitstream-list.component';
 import { VirtualMetadataComponent } from './virtual-metadata/virtual-metadata.component';
 import { ItemVersionHistoryComponent } from './item-version-history/item-version-history.component';
 import { ItemAuthorizationsComponent } from './item-authorizations/item-authorizations.component';
@@ -35,15 +43,10 @@ import { ItemVersionsModule } from '../versions/item-versions.module';
 import { IdentifierDataService } from '../../core/data/identifier-data.service';
 import { IdentifierDataComponent } from '../../shared/object-list/identifier-data/identifier-data.component';
 import { ItemRegisterDoiComponent } from './item-register-doi/item-register-doi.component';
-import { DsoSharedModule } from '../../dso-shared/dso-shared.module';
 import { ItemCurateComponent } from './item-curate/item-curate.component';
 import { ThemedItemStatusComponent } from './item-status/themed-item-status.component';
 
 import { ItemAccessControlComponent } from './item-access-control/item-access-control.component';
-import { ResultsBackButtonModule } from '../../shared/results-back-button/results-back-button.module';
-import {
-  AccessControlFormModule
-} from '../../shared/access-control-form-container/access-control-form.module';
 
 /**
  * Module that contains all components related to the Edit Item page administrator functionality
@@ -57,9 +60,6 @@ import {
     ResourcePoliciesModule,
     NgbModule,
     ItemVersionsModule,
-        DsoSharedModule,
-        ResultsBackButtonModule,
-        AccessControlFormModule,
     EditItemPageComponent,
     ItemOperationComponent,
     AbstractSimpleItemActionComponent,

src/app/item-page/item-page.module.ts

@@ -43,7 +43,6 @@ import { NgbAccordionModule } from '@ng-bootstrap/ng-bootstrap';
 import { OrcidSyncSettingsComponent } from './orcid-page/orcid-sync-settings/orcid-sync-settings.component';
 import { OrcidQueueComponent } from './orcid-page/orcid-queue/orcid-queue.component';
 import { UploadModule } from '../shared/upload/upload.module';
-import { ResultsBackButtonModule } from '../shared/results-back-button/results-back-button.module';
 import { ItemAlertsComponent } from './alerts/item-alerts.component';
 import { ItemVersionsModule } from './versions/item-versions.module';
 import {
@@ -103,7 +102,6 @@ const DECLARATIONS = [
     StatisticsModule.forRoot(),
     NgxGalleryModule,
     NgbAccordionModule,
-        ResultsBackButtonModule,
     UploadModule,
     DsoPageModule,
     ...DECLARATIONS

src/app/shared/access-control-form-container/access-control-form-container.component.spec.ts

@@ -16,7 +16,6 @@ import {UiSwitchModule} from 'ngx-ui-switch';
 import {
   ITEM_ACCESS_CONTROL_SELECT_BITSTREAMS_LIST_ID
 } from './item-access-control-select-bitstreams-modal/item-access-control-select-bitstreams-modal.component';
-import {AccessControlFormModule} from './access-control-form.module';
 
 
 describe('AccessControlFormContainerComponent', () => {
@@ -31,7 +30,6 @@ describe('AccessControlFormContainerComponent', () => {
     imports: [CommonModule,
         FormsModule,
         SharedBrowseByModule,
-        AccessControlFormModule,
         NgbDatepickerModule,
         UiSwitchModule]
 })
@@ -65,7 +63,6 @@ describe('AccessControlFormContainerComponent', () => {
         CommonModule,
         FormsModule,
         SharedBrowseByModule,
-        AccessControlFormModule,
         TranslateModule.forRoot(),
         NgbDatepickerModule,
         UiSwitchModule,

src/app/shared/access-control-form-container/access-control-form.module.ts

@@ -1,28 +0,0 @@
-import {NgModule} from '@angular/core';
-import {CommonModule} from '@angular/common';
-
-import {TranslateModule} from '@ngx-translate/core';
-import {UiSwitchModule} from 'ngx-ui-switch';
-
-import {AccessControlArrayFormComponent} from './access-control-array-form/access-control-array-form.component';
-import {
-  ItemAccessControlSelectBitstreamsModalComponent
-} from './item-access-control-select-bitstreams-modal/item-access-control-select-bitstreams-modal.component';
-import {AccessControlFormContainerComponent} from './access-control-form-container.component';
-import {NgbDatepickerModule} from '@ng-bootstrap/ng-bootstrap';
-import {ToDatePipe} from './access-control-array-form/to-date.pipe';
-
-@NgModule({
-    imports: [
-        CommonModule,
-        TranslateModule,
-        UiSwitchModule,
-        NgbDatepickerModule,
-        AccessControlFormContainerComponent,
-        AccessControlArrayFormComponent,
-        ItemAccessControlSelectBitstreamsModalComponent,
-        ToDatePipe
-    ],
-    exports: [AccessControlFormContainerComponent, AccessControlArrayFormComponent]
-})
-export class AccessControlFormModule {}

src/app/shared/browse-by/shared-browse-by.module.ts

@@ -2,7 +2,6 @@ import { NgModule } from '@angular/core';
 import { BrowseByComponent } from './browse-by.component';
 import { ThemedBrowseByComponent } from './themed-browse-by.component';
 import { CommonModule } from '@angular/common';
-import { ResultsBackButtonModule } from '../results-back-button/results-back-button.module';
 
 const DECLARATIONS = [
   BrowseByComponent,
@@ -11,9 +10,8 @@ const DECLARATIONS = [
 
 @NgModule({
     imports: [
-        ResultsBackButtonModule,
     CommonModule,
-        ...DECLARATIONS,
+    ...DECLARATIONS
 ],
     exports: [
       ...DECLARATIONS,

src/app/shared/log-in/methods/log-in.methods-decorator.ts

@@ -13,6 +13,9 @@ export const AUTH_METHOD_FOR_DECORATOR_MAP = new Map<AuthMethodType, AuthMethodT
   [AuthMethodType.Orcid, LogInExternalProviderComponent]
 ]);
 
+/**
+ * @deprecated
+ */
 export function renderAuthMethodFor(authMethodType: AuthMethodType) {
   return function decorator(objectElement: any) {
     if (!objectElement) {

src/app/shared/menu/menu-item.decorator.ts

@@ -14,6 +14,7 @@ menuMenuItemComponentMap.set(MenuItemType.TEXT, TextMenuItemComponent);
 /**
  * Decorator function to link a MenuItemType to a Component
  * @param {MenuItemType} type The MenuItemType of the MenuSection's model
+ * @deprecated
  * @returns {(sectionComponent: GenericContructor) => void}
  */
 export function rendersMenuItemForType(type: MenuItemType) {

src/app/shared/menu/menu-section.decorator.ts

@@ -38,6 +38,7 @@ menuComponentMap.get(MenuID.DSO_EDIT).get(true).set(DEFAULT_THEME, DsoEditMenuEx
  * Decorator function to render a MenuSection for a menu
  * @param {MenuID} menuID The ID of the Menu in which the section is rendered
  * @param {boolean} expandable True when the section should be expandable, false when if should not
+ * @deprecated
  * @returns {(menuSectionWrapperComponent: GenericConstructor) => void}
  */
 export function rendersSectionForMenu(menuID: MenuID, expandable: boolean, theme = DEFAULT_THEME) {

src/app/shared/metadata-representation/metadata-representation.decorator.ts

@@ -74,6 +74,7 @@ export const METADATA_REPRESENTATION_COMPONENT_DECORATOR_MAP =
  * @param mdRepresentationType The metadata representation type the component represents
  * @param context The optional context the component represents
  * @param theme The optional theme for the component
+ * @deprecated
  */
 export function metadataRepresentationComponent(entityType: string, mdRepresentationType: MetadataRepresentationType, context: Context = DEFAULT_CONTEXT, theme = DEFAULT_THEME) {
   return function decorator(component: any) {

src/app/shared/mydspace-actions/claimed-task/switcher/claimed-task-actions-decorator.ts

@@ -75,6 +75,7 @@ export function rendersWorkflowTaskOption(option: string) {
 
 /**
  * Decorator used for rendering AdvancedClaimedTaskActions pages by option type
+ * @deprecated
  */
 export function rendersAdvancedWorkflowTaskOption(option: string) {
   return function decorator(component: any) {

src/app/shared/results-back-button/results-back-button.module.ts

@@ -1,20 +0,0 @@
-import { NgModule } from '@angular/core';
-import { CommonModule } from '@angular/common';
-import { TranslateModule } from '@ngx-translate/core';
-import { ResultsBackButtonComponent } from './results-back-button.component';
-import { ThemedResultsBackButtonComponent } from './themed-results-back-button.component';
-
-@NgModule({
-    imports: [
-        CommonModule,
-        TranslateModule,
-        ResultsBackButtonComponent,
-        ThemedResultsBackButtonComponent
-    ],
-    exports: [
-        ThemedResultsBackButtonComponent
-    ]
-})
-export class ResultsBackButtonModule {
-
-}

src/app/shared/search/search-filters/search-filter/search-filter-type-decorator.ts

@@ -19,6 +19,7 @@ filterTypeMap.set(FilterType.range, SearchRangeFilterComponent);
 /**
  * Sets the mapping for a facet component in relation to a filter type
  * @param {FilterType} type The type for which the matching component is mapped
+ * @deprecated
  * @returns Decorator function that performs the actual mapping on initialization of the facet component
  */
 export function renderFacetFor(type: FilterType) {

src/app/shared/starts-with/starts-with-decorator.ts

@@ -18,6 +18,7 @@ export const STARTS_WITH_DECORATOR_MAP = new Map<StartsWithType, StartsWithCompo
 /**
  * Fetch a decorator to render a StartsWith component for type
  * @param type
+ * @deprecated
  */
 export function renderStartsWithFor(type: StartsWithType) {
   return function decorator(objectElement: any) {

src/app/submission/sections/sections-decorator.ts

@@ -17,6 +17,9 @@ submissionSectionsMap.set(SectionsType.Upload, SubmissionSectionUploadComponent)
 submissionSectionsMap.set(SectionsType.SubmissionForm, SubmissionSectionFormComponent);
 submissionSectionsMap.set(SectionsType.Identifiers, SubmissionSectionIdentifiersComponent);
 
+/**
+ * @deprecated
+ */
 export function renderSectionFor(sectionType: SectionsType) {
   return function decorator(objectElement: any) {
     if (!objectElement) {

src/themes/custom/eager-theme.module.ts

@@ -37,11 +37,15 @@ import {
 import {
   EditItemSelectorComponent
 } from './app/shared/dso-selector/modal-wrappers/edit-item-selector/edit-item-selector.component';
-import { CommunityListElementComponent } from './app/shared/object-list/community-list-element/community-list-element.component';
-import { CollectionListElementComponent} from './app/shared/object-list/collection-list-element/collection-list-element.component';
+import {
+  CommunityListElementComponent
+} from './app/shared/object-list/community-list-element/community-list-element.component';
+import {
+  CollectionListElementComponent
+} from './app/shared/object-list/collection-list-element/collection-list-element.component';
 import { CollectionDropdownComponent } from './app/shared/collection-dropdown/collection-dropdown.component';
 import { SharedBrowseByModule } from '../../app/shared/browse-by/shared-browse-by.module';
-import { ResultsBackButtonModule } from '../../app/shared/results-back-button/results-back-button.module';
+
 import { DsoPageModule } from '../../app/shared/dso-page/dso-page.module';
 import { FileDownloadLinkComponent } from './app/shared/file-download-link/file-download-link.component';
 import { StartsWithDateComponent } from './app/shared/starts-with/date/starts-with-date.component';
@@ -52,9 +56,13 @@ import {
 import {
   ItemSearchResultListElementComponent
 } from './app/shared/object-list/search-result-list-element/item-search-result/item-types/item/item-search-result-list-element.component';
-import { TopLevelCommunityListComponent } from './app/home-page/top-level-community-list/top-level-community-list.component';
+import {
+  TopLevelCommunityListComponent
+} from './app/home-page/top-level-community-list/top-level-community-list.component';
 import { LogInComponent } from './app/shared/log-in/log-in.component';
-import { BrowseEntryListElementComponent } from './app/shared/object-list/browse-entry-list-element/browse-entry-list-element.component';
+import {
+  BrowseEntryListElementComponent
+} from './app/shared/object-list/browse-entry-list-element/browse-entry-list-element.component';
 import { PersonComponent } from './app/entity-groups/research-entities/item-pages/person/person.component';
 import { LangSwitchComponent } from './app/shared/lang-switch/lang-switch.component';
 
@@ -106,7 +114,6 @@ const DECLARATIONS = [
     RootModule,
     NavbarModule,
     SharedBrowseByModule,
-        ResultsBackButtonModule,
     ItemPageModule,
     ItemSharedModule,
     DsoPageModule,

src/themes/custom/lazy-theme.module.ts

@@ -110,7 +110,6 @@ import {
   ExternalSourceEntryImportModalComponent
 } from './app/shared/form/builder/ds-dynamic-form-ui/relation-lookup-modal/external-source-tab/external-source-entry-import-modal/external-source-entry-import-modal.component';
 import { SharedBrowseByModule } from '../../app/shared/browse-by/shared-browse-by.module';
-import { ResultsBackButtonModule } from '../../app/shared/results-back-button/results-back-button.module';
 import { ItemVersionsModule } from '../../app/item-page/versions/item-versions.module';
 import { ItemSharedModule } from '../../app/item-page/item-shared.module';
 import { SearchFiltersComponent } from './app/shared/search/search-filters/search-filters.component';
@@ -126,7 +125,6 @@ import {
 } from './app/shared/object-collection/shared/badges/access-status-badge/access-status-badge.component';
 import { ResultsBackButtonComponent } from './app/shared/results-back-button/results-back-button.component';
 import { DsoEditMetadataComponent } from './app/dso-shared/dso-edit-metadata/dso-edit-metadata.component';
-import { DsoSharedModule } from '../../app/dso-shared/dso-shared.module';
 import { SystemWideAlertModule } from '../../app/system-wide-alert/system-wide-alert.module';
 import { DsoPageModule } from '../../app/shared/dso-page/dso-page.module';
 import { ItemAlertsComponent } from './app/item-page/alerts/item-alerts.component';
@@ -284,7 +282,6 @@ const DECLARATIONS = [
     ScrollToModule,
     SearchPageModule,
     SharedBrowseByModule,
-        ResultsBackButtonModule,
     StatisticsModule,
     StatisticsPageModule,
     StoreModule,
@@ -296,7 +293,6 @@ const DECLARATIONS = [
     FormsModule,
     ResourcePoliciesModule,
     ComcolModule,
-        DsoSharedModule,
     SystemWideAlertModule,
     NgxGalleryModule,
     FormModule,

src/themes/dspace/eager-theme.module.ts

@@ -7,7 +7,6 @@ import { HeaderNavbarWrapperComponent } from './app/header-nav-wrapper/header-na
 import { RootModule } from '../../app/root.module';
 import { NavbarModule } from '../../app/navbar/navbar.module';
 import { SharedBrowseByModule } from '../../app/shared/browse-by/shared-browse-by.module';
-import { ResultsBackButtonModule } from '../../app/shared/results-back-button/results-back-button.module';
 
 /**
  * Add components that use a custom decorator to ENTRY_COMPONENTS as well as DECLARATIONS.
@@ -27,7 +26,6 @@ const DECLARATIONS = [
     imports: [
     CommonModule,
     SharedBrowseByModule,
-        ResultsBackButtonModule,
     RootModule,
     NavbarModule,
     ...DECLARATIONS

src/themes/dspace/lazy-theme.module.ts

@@ -30,7 +30,6 @@ import { ResourcePoliciesModule } from '../../app/shared/resource-policies/resou
 import { ComcolModule } from '../../app/shared/comcol/comcol.module';
 import { RootModule } from '../../app/root.module';
 import { BrowseByPageModule } from '../../app/browse-by/browse-by-page.module';
-import { ResultsBackButtonModule } from '../../app/shared/results-back-button/results-back-button.module';
 import { SharedBrowseByModule } from '../../app/shared/browse-by/shared-browse-by.module';
 import { ItemVersionsModule } from '../../app/item-page/versions/item-versions.module';
 import { ItemSharedModule } from 'src/app/item-page/item-shared.module';
@@ -43,7 +42,6 @@ const DECLARATIONS = [
     AppModule,
     RootModule,
     BrowseByPageModule,
-    ResultsBackButtonModule,
     CollectionFormModule,
     CollectionPageModule,
     CommonModule,
@@ -75,7 +73,7 @@ const DECLARATIONS = [
     SearchModule,
     FormsModule,
     ResourcePoliciesModule,
-    ComcolModule,
+    ComcolModule
 ],
   declarations: DECLARATIONS,
 })