Updated TypeDoc for themed components

This commit is contained in:
lotte
2021-03-17 12:09:50 +01:00
committed by Art Lowel
parent b12e616ff6
commit c19ee0d49e
15 changed files with 43 additions and 57 deletions

View File

@@ -3,14 +3,14 @@ import { Component } from '@angular/core';
import { ThemedComponent } from '../../shared/theme-support/themed.component'; import { ThemedComponent } from '../../shared/theme-support/themed.component';
import { BrowseBySwitcherComponent } from './browse-by-switcher.component'; import { BrowseBySwitcherComponent } from './browse-by-switcher.component';
/**
* Themed wrapper for BrowseBySwitcherComponent
*/
@Component({ @Component({
selector: 'ds-themed-browse-by-switcher', selector: 'ds-themed-browse-by-switcher',
styleUrls: [], styleUrls: [],
templateUrl: '../../shared/theme-support/themed.component.html' templateUrl: '../../shared/theme-support/themed.component.html'
}) })
/**
* Component for determining what Browse-By component to use depending on the metadata (browse ID) provided
*/
export class ThemedBrowseBySwitcherComponent extends ThemedComponent<BrowseBySwitcherComponent> { export class ThemedBrowseBySwitcherComponent extends ThemedComponent<BrowseBySwitcherComponent> {
protected getComponentName(): string { protected getComponentName(): string {
return 'BrowseBySwitcherComponent'; return 'BrowseBySwitcherComponent';

View File

@@ -2,15 +2,14 @@ import { Component } from '@angular/core';
import { ThemedComponent } from '../shared/theme-support/themed.component'; import { ThemedComponent } from '../shared/theme-support/themed.component';
import { CollectionPageComponent } from './collection-page.component'; import { CollectionPageComponent } from './collection-page.component';
/**
* Themed wrapper for CollectionPageComponent
*/
@Component({ @Component({
selector: 'ds-themed-community-page', selector: 'ds-themed-community-page',
styleUrls: [], styleUrls: [],
templateUrl: '../shared/theme-support/themed.component.html', templateUrl: '../shared/theme-support/themed.component.html',
}) })
/**
* Component to render the news section on the home page
*/
export class ThemedCollectionPageComponent extends ThemedComponent<CollectionPageComponent> { export class ThemedCollectionPageComponent extends ThemedComponent<CollectionPageComponent> {
protected getComponentName(): string { protected getComponentName(): string {
return 'CollectionPageComponent'; return 'CollectionPageComponent';

View File

@@ -2,15 +2,14 @@ import { Component } from '@angular/core';
import { ThemedComponent } from '../shared/theme-support/themed.component'; import { ThemedComponent } from '../shared/theme-support/themed.component';
import { CommunityPageComponent } from './community-page.component'; import { CommunityPageComponent } from './community-page.component';
/**
* Themed wrapper for CommunityPageComponent
*/
@Component({ @Component({
selector: 'ds-themed-community-page', selector: 'ds-themed-community-page',
styleUrls: [], styleUrls: [],
templateUrl: '../shared/theme-support/themed.component.html', templateUrl: '../shared/theme-support/themed.component.html',
}) })
/**
* Component to render the news section on the home page
*/
export class ThemedCommunityPageComponent extends ThemedComponent<CommunityPageComponent> { export class ThemedCommunityPageComponent extends ThemedComponent<CommunityPageComponent> {
protected getComponentName(): string { protected getComponentName(): string {
return 'CommunityPageComponent'; return 'CommunityPageComponent';

View File

@@ -2,15 +2,14 @@ import { Component } from '@angular/core';
import { ThemedComponent } from '../../shared/theme-support/themed.component'; import { ThemedComponent } from '../../shared/theme-support/themed.component';
import { ObjectNotFoundComponent } from './objectnotfound.component'; import { ObjectNotFoundComponent } from './objectnotfound.component';
/**
* Themed wrapper for ObjectNotFoundComponent
*/
@Component({ @Component({
selector: 'ds-themed-objnotfound', selector: 'ds-themed-objnotfound',
styleUrls: [], styleUrls: [],
templateUrl: '../../shared/theme-support/themed.component.html', templateUrl: '../../shared/theme-support/themed.component.html',
}) })
/**
* Component to render the news section on the home page
*/
export class ThemedObjectNotFoundComponent extends ThemedComponent<ObjectNotFoundComponent> { export class ThemedObjectNotFoundComponent extends ThemedComponent<ObjectNotFoundComponent> {
protected getComponentName(): string { protected getComponentName(): string {
return 'ObjectNotFoundComponent'; return 'ObjectNotFoundComponent';

View File

@@ -4,15 +4,14 @@ import { ConfigurationSearchPageComponent } from './configuration-search-page.co
import { Observable } from 'rxjs'; import { Observable } from 'rxjs';
import { Context } from '../core/shared/context.model'; import { Context } from '../core/shared/context.model';
/**
* Themed wrapper for ConfigurationSearchPageComponent
*/
@Component({ @Component({
selector: 'ds-themed-configuration-search-page', selector: 'ds-themed-configuration-search-page',
styleUrls: [], styleUrls: [],
templateUrl: '../shared/theme-support/themed.component.html', templateUrl: '../shared/theme-support/themed.component.html',
}) })
/**
* Component to render the news section on the home page
*/
export class ThemedConfigurationSearchPageComponent extends ThemedComponent<ConfigurationSearchPageComponent> { export class ThemedConfigurationSearchPageComponent extends ThemedComponent<ConfigurationSearchPageComponent> {
/** /**
* The configuration to use for the search options * The configuration to use for the search options

View File

@@ -2,15 +2,14 @@ import { Component } from '@angular/core';
import { ThemedComponent } from '../shared/theme-support/themed.component'; import { ThemedComponent } from '../shared/theme-support/themed.component';
import { SearchPageComponent } from './search-page.component'; import { SearchPageComponent } from './search-page.component';
/**
* Themed wrapper for SearchPageComponent
*/
@Component({ @Component({
selector: 'ds-themed-search-page', selector: 'ds-themed-search-page',
styleUrls: [], styleUrls: [],
templateUrl: '../shared/theme-support/themed.component.html', templateUrl: '../shared/theme-support/themed.component.html',
}) })
/**
* This component represents the whole search page
* It renders search results depending on the current search options
*/
export class ThemedSearchPageComponent extends ThemedComponent<SearchPageComponent> { export class ThemedSearchPageComponent extends ThemedComponent<SearchPageComponent> {
protected getComponentName(): string { protected getComponentName(): string {

View File

@@ -3,8 +3,7 @@ import { ThemedComponent } from '../shared/theme-support/themed.component';
import { CommunityListPageComponent } from './community-list-page.component'; import { CommunityListPageComponent } from './community-list-page.component';
/** /**
* Page with title and the community list tree, as described in community-list.component; * Themed wrapper for CommunityListPageComponent
* navigated to with community-list.page.routing.module
*/ */
@Component({ @Component({
selector: 'ds-themed-community-list-page', selector: 'ds-themed-community-list-page',

View File

@@ -2,15 +2,14 @@ import { Component } from '@angular/core';
import { ThemedComponent } from '../shared/theme-support/themed.component'; import { ThemedComponent } from '../shared/theme-support/themed.component';
import { ForbiddenComponent } from './forbidden.component'; import { ForbiddenComponent } from './forbidden.component';
/**
* Themed wrapper for ForbiddenComponent
*/
@Component({ @Component({
selector: 'ds-themed-forbidden', selector: 'ds-themed-forbidden',
styleUrls: [], styleUrls: [],
templateUrl: '../shared/theme-support/themed.component.html', templateUrl: '../shared/theme-support/themed.component.html',
}) })
/**
* Component to render the news section on the home page
*/
export class ThemedForbiddenComponent extends ThemedComponent<ForbiddenComponent> { export class ThemedForbiddenComponent extends ThemedComponent<ForbiddenComponent> {
protected getComponentName(): string { protected getComponentName(): string {
return 'ForbiddenComponent'; return 'ForbiddenComponent';

View File

@@ -2,15 +2,14 @@ import { Component } from '@angular/core';
import { ThemedComponent } from '../../shared/theme-support/themed.component'; import { ThemedComponent } from '../../shared/theme-support/themed.component';
import { EndUserAgreementComponent } from './end-user-agreement.component'; import { EndUserAgreementComponent } from './end-user-agreement.component';
/**
* Themed wrapper for EndUserAgreementComponent
*/
@Component({ @Component({
selector: 'ds-themed-end-user-agreement', selector: 'ds-themed-end-user-agreement',
styleUrls: [], styleUrls: [],
templateUrl: '../../shared/theme-support/themed.component.html', templateUrl: '../../shared/theme-support/themed.component.html',
}) })
/**
* Component to render the news section on the home page
*/
export class ThemedEndUserAgreementComponent extends ThemedComponent<EndUserAgreementComponent> { export class ThemedEndUserAgreementComponent extends ThemedComponent<EndUserAgreementComponent> {
protected getComponentName(): string { protected getComponentName(): string {

View File

@@ -2,15 +2,14 @@ import { Component } from '@angular/core';
import { ThemedComponent } from '../../shared/theme-support/themed.component'; import { ThemedComponent } from '../../shared/theme-support/themed.component';
import { PrivacyComponent } from './privacy.component'; import { PrivacyComponent } from './privacy.component';
/**
* Themed wrapper for PrivacyComponent
*/
@Component({ @Component({
selector: 'ds-themed-privacy', selector: 'ds-themed-privacy',
styleUrls: [], styleUrls: [],
templateUrl: '../../shared/theme-support/themed.component.html', templateUrl: '../../shared/theme-support/themed.component.html',
}) })
/**
* Component to render the news section on the home page
*/
export class ThemedPrivacyComponent extends ThemedComponent<PrivacyComponent> { export class ThemedPrivacyComponent extends ThemedComponent<PrivacyComponent> {
protected getComponentName(): string { protected getComponentName(): string {
return 'PrivacyComponent'; return 'PrivacyComponent';

View File

@@ -2,15 +2,14 @@ import { Component } from '@angular/core';
import { ThemedComponent } from '../shared/theme-support/themed.component'; import { ThemedComponent } from '../shared/theme-support/themed.component';
import { PageNotFoundComponent } from './pagenotfound.component'; import { PageNotFoundComponent } from './pagenotfound.component';
/**
* Themed wrapper for PageNotFoundComponent
*/
@Component({ @Component({
selector: 'ds-themed-search-page', selector: 'ds-themed-search-page',
styleUrls: [], styleUrls: [],
templateUrl: '../shared/theme-support/themed.component.html', templateUrl: '../shared/theme-support/themed.component.html',
}) })
/**
* This component represents the whole search page
* It renders search results depending on the current search options
*/
export class ThemedPageNotFoundComponent extends ThemedComponent<PageNotFoundComponent> { export class ThemedPageNotFoundComponent extends ThemedComponent<PageNotFoundComponent> {
protected getComponentName(): string { protected getComponentName(): string {

View File

@@ -2,15 +2,14 @@ import { Component } from '@angular/core';
import { ThemedComponent } from '../../shared/theme-support/themed.component'; import { ThemedComponent } from '../../shared/theme-support/themed.component';
import { CollectionStatisticsPageComponent } from './collection-statistics-page.component'; import { CollectionStatisticsPageComponent } from './collection-statistics-page.component';
/**
* Themed wrapper for CollectionStatisticsPageComponent
*/
@Component({ @Component({
selector: 'ds-themed-collection-statistics-page', selector: 'ds-themed-collection-statistics-page',
styleUrls: [], styleUrls: [],
templateUrl: '../../shared/theme-support/themed.component.html', templateUrl: '../../shared/theme-support/themed.component.html',
}) })
/**
* Component to render the news section on the home page
*/
export class ThemedCollectionStatisticsPageComponent extends ThemedComponent<CollectionStatisticsPageComponent> { export class ThemedCollectionStatisticsPageComponent extends ThemedComponent<CollectionStatisticsPageComponent> {
protected getComponentName(): string { protected getComponentName(): string {
return 'CollectionStatisticsPageComponent'; return 'CollectionStatisticsPageComponent';

View File

@@ -2,15 +2,14 @@ import { Component } from '@angular/core';
import { ThemedComponent } from '../../shared/theme-support/themed.component'; import { ThemedComponent } from '../../shared/theme-support/themed.component';
import { CommunityStatisticsPageComponent } from './community-statistics-page.component'; import { CommunityStatisticsPageComponent } from './community-statistics-page.component';
/**
* Themed wrapper for CommunityStatisticsPageComponent
*/
@Component({ @Component({
selector: 'ds-themed-collection-statistics-page', selector: 'ds-themed-collection-statistics-page',
styleUrls: [], styleUrls: [],
templateUrl: '../../shared/theme-support/themed.component.html', templateUrl: '../../shared/theme-support/themed.component.html',
}) })
/**
* Component to render the news section on the home page
*/
export class ThemedCommunityStatisticsPageComponent extends ThemedComponent<CommunityStatisticsPageComponent> { export class ThemedCommunityStatisticsPageComponent extends ThemedComponent<CommunityStatisticsPageComponent> {
protected getComponentName(): string { protected getComponentName(): string {
return 'CommunityStatisticsPageComponent'; return 'CommunityStatisticsPageComponent';

View File

@@ -2,15 +2,14 @@ import { Component } from '@angular/core';
import { ThemedComponent } from '../../shared/theme-support/themed.component'; import { ThemedComponent } from '../../shared/theme-support/themed.component';
import { ItemStatisticsPageComponent } from './item-statistics-page.component'; import { ItemStatisticsPageComponent } from './item-statistics-page.component';
/**
* Themed wrapper for ItemStatisticsPageComponent
*/
@Component({ @Component({
selector: 'ds-themed-item-statistics-page', selector: 'ds-themed-item-statistics-page',
styleUrls: [], styleUrls: [],
templateUrl: '../../shared/theme-support/themed.component.html', templateUrl: '../../shared/theme-support/themed.component.html',
}) })
/**
* Component to render the news section on the home page
*/
export class ThemedItemStatisticsPageComponent extends ThemedComponent<ItemStatisticsPageComponent> { export class ThemedItemStatisticsPageComponent extends ThemedComponent<ItemStatisticsPageComponent> {
protected getComponentName(): string { protected getComponentName(): string {
return 'ItemStatisticsPageComponent'; return 'ItemStatisticsPageComponent';

View File

@@ -2,15 +2,14 @@ import { Component } from '@angular/core';
import { ThemedComponent } from '../../shared/theme-support/themed.component'; import { ThemedComponent } from '../../shared/theme-support/themed.component';
import { SiteStatisticsPageComponent } from './site-statistics-page.component'; import { SiteStatisticsPageComponent } from './site-statistics-page.component';
/**
* Themed wrapper for SiteStatisticsPageComponent
*/
@Component({ @Component({
selector: 'ds-themed-site-statistics-page', selector: 'ds-themed-site-statistics-page',
styleUrls: [], styleUrls: [],
templateUrl: '../../shared/theme-support/themed.component.html', templateUrl: '../../shared/theme-support/themed.component.html',
}) })
/**
* Component to render the news section on the home page
*/
export class ThemedSiteStatisticsPageComponent extends ThemedComponent<SiteStatisticsPageComponent> { export class ThemedSiteStatisticsPageComponent extends ThemedComponent<SiteStatisticsPageComponent> {
protected getComponentName(): string { protected getComponentName(): string {
return 'SiteStatisticsPageComponent'; return 'SiteStatisticsPageComponent';