added TypeDoc

This commit is contained in:
lotte
2019-10-16 11:21:25 +02:00
parent 7ca88021c9
commit d962e40c58
84 changed files with 479 additions and 93 deletions

View File

@@ -11,6 +11,8 @@ import { listableObjectComponent } from '../../../object-collection/shared/lista
styleUrls: ['../search-result-grid-element.component.scss', 'collection-search-result-grid-element.component.scss'],
templateUrl: 'collection-search-result-grid-element.component.html'
})
/**
* Component representing a grid element for a collection search result
*/
@listableObjectComponent(CollectionSearchResult, ViewMode.GridElement)
export class CollectionSearchResultGridElementComponent extends SearchResultGridElementComponent<CollectionSearchResult, Collection> {}

View File

@@ -10,8 +10,9 @@ import { listableObjectComponent } from '../../../object-collection/shared/lista
styleUrls: ['../search-result-grid-element.component.scss', 'community-search-result-grid-element.component.scss'],
templateUrl: 'community-search-result-grid-element.component.html'
})
/**
* Component representing a grid element for a community search result
*/
@listableObjectComponent(CommunitySearchResult, ViewMode.GridElement)
export class CommunitySearchResultGridElementComponent extends SearchResultGridElementComponent<CommunitySearchResult, Community> {
}

View File

@@ -14,7 +14,7 @@ import { ItemSearchResult } from '../../../../object-collection/shared/item-sear
animations: [focusShadow]
})
/**
* The component for displaying a grid element for an item of the type Publication
* The component for displaying a grid element for an item search result of the type Publication
*/
export class PublicationSearchResultGridElementComponent extends SearchResultGridElementComponent<ItemSearchResult, Item> {
}

View File

@@ -14,7 +14,14 @@ import { hasValue } from '../../empty.util';
})
export class SearchResultGridElementComponent<T extends SearchResult<K>, K extends DSpaceObject> extends AbstractListableElementComponent<T> implements OnInit {
/**
* The DSpaceObject of the search result
*/
dso: K;
/**
* Whether or not the grid element is currently collapsed
*/
isCollapsed$: Observable<boolean>;
public constructor(protected truncatableService: TruncatableService) {
@@ -24,6 +31,9 @@ export class SearchResultGridElementComponent<T extends SearchResult<K>, K exten
}
}
/**
* Retrieve the dso from the search result
*/
ngOnInit(): void {
if (hasValue(this.object)) {
this.dso = this.object.indexableObject;