added TypeDoc

src/app/shared/object-grid/collection-grid-element/collection-grid-element.component.ts

@@ -5,6 +5,9 @@ import { AbstractListableElementComponent } from '../../object-collection/shared
 import { ViewMode } from '../../../core/shared/view-mode.model';
 import { listableObjectComponent } from '../../object-collection/shared/listable-object/listable-object.decorator';
 
+/**
+ * Component representing a grid element for collection
+ */
 @Component({
   selector: 'ds-collection-grid-element',
   styleUrls: ['./collection-grid-element.component.scss'],

src/app/shared/object-grid/community-grid-element/community-grid-element.component.ts

@@ -5,6 +5,9 @@ import { AbstractListableElementComponent } from '../../object-collection/shared
 import { ViewMode } from '../../../core/shared/view-mode.model';
 import { listableObjectComponent } from '../../object-collection/shared/listable-object/listable-object.decorator';
 
+/**
+ * Component representing a grid element for a community
+ */
 @Component({
   selector: 'ds-community-grid-element',
   styleUrls: ['./community-grid-element.component.scss'],

src/app/shared/object-grid/object-grid.component.ts

@@ -34,20 +34,57 @@ import { CollectionElementLinkType } from '../object-collection/collection-eleme
 })
 
 export class ObjectGridComponent implements OnInit {
+  /**
+   * The view mode of the this component
+   */
   viewMode = ViewMode.GridElement;
 
+  /**
+   * The current pagination configuration
+   */
   @Input() config: PaginationComponentOptions;
+
+  /**
+   * The current sort configuration
+   */
   @Input() sortConfig: SortOptions;
+
+  /**
+   * The whether or not the gear is hidden
+   */
   @Input() hideGear = false;
+
+  /**
+   * Whether or not the pager is visible when there is only a single page of results
+   */
   @Input() hidePagerWhenSinglePage = true;
+
+  /**
+   * The link type of the listable elements
+   */
   @Input() linkType: CollectionElementLinkType;
+
+  /**
+   * The context of the listable elements
+   */
   @Input() context: Context;
+
+  /**
+   * Behavior subject to output the current listable objects
+   */
   private _objects$: BehaviorSubject<RemoteData<PaginatedList<ListableObject>>>;
 
+  /**
+   * Setter to make sure the observable is turned into an observable
+   * @param objects The new objects to output
+   */
   @Input() set objects(objects: RemoteData<PaginatedList<ListableObject>>) {
     this._objects$.next(objects);
   }
 
+  /**
+   * Getter to return the current objects
+   */
   get objects() {
     return this._objects$.getValue();
   }
@@ -82,7 +119,10 @@ export class ObjectGridComponent implements OnInit {
    */
   @Output() sortDirectionChange: EventEmitter<SortDirection> = new EventEmitter<SortDirection>();
 
-  @Output() paginationChange: EventEmitter<SortDirection> = new EventEmitter<any>();
+  /**
+   * An event fired when on of the pagination parameters changes
+   */
+  @Output() paginationChange: EventEmitter<any> = new EventEmitter<any>();
 
   /**
    * An event fired when the sort field is changed.
@@ -96,6 +136,9 @@ export class ObjectGridComponent implements OnInit {
     this._objects$ = new BehaviorSubject(undefined);
   }
 
+  /**
+   * Initialize the instance variables
+   */
   ngOnInit(): void {
     const nbColumns$ = this.hostWindow.widthCategory.pipe(
       map((widthCat: WidthCategory) => {
@@ -139,22 +182,40 @@ export class ObjectGridComponent implements OnInit {
     }));
   }
 
+  /**
+   * Emits the current page when it changes
+   * @param event The new page
+   */
   onPageChange(event) {
     this.pageChange.emit(event);
   }
-
+  /**
+   * Emits the current page size when it changes
+   * @param event The new page size
+   */
   onPageSizeChange(event) {
     this.pageSizeChange.emit(event);
   }
-
+  /**
+   * Emits the current sort direction when it changes
+   * @param event The new sort direction
+   */
   onSortDirectionChange(event) {
     this.sortDirectionChange.emit(event);
   }
 
+  /**
+   * Emits the current sort field when it changes
+   * @param event The new sort field
+   */
   onSortFieldChange(event) {
     this.sortFieldChange.emit(event);
   }
 
+  /**
+   * Emits the current pagination when it changes
+   * @param event The new pagination
+   */
   onPaginationChange(event) {
     this.paginationChange.emit(event);
   }

src/app/shared/object-grid/search-result-grid-element/collection-search-result/collection-search-result-grid-element.component.ts

@@ -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> {}

src/app/shared/object-grid/search-result-grid-element/community-search-result/community-search-result-grid-element.component.ts

@@ -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> {
-
 }

src/app/shared/object-grid/search-result-grid-element/item-search-result/publication/publication-search-result-grid-element.component.ts

@@ -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> {
 }

src/app/shared/object-grid/search-result-grid-element/search-result-grid-element.component.ts

@@ -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;