[ACS-6071] fix jsdoc warnings and errors (#8948)

* fix content docs

* fix extensions docs

* fix insights docs

* [ci:force] fix jsdoc errors and warnings

* enable jsdoc linter

* [ci:force] fix demo shell jsdoc

* [ci:force] fix e2e typings

* fix typo

* fix typo
This commit is contained in:
Denys Vuika
2023-09-29 08:11:58 +01:00
committed by GitHub
parent 501516c8f5
commit d72eb5ebd3
86 changed files with 1233 additions and 254 deletions

View File

@@ -54,6 +54,7 @@ export class AppExtensionService {
* The result is filtered by the **disabled** state.
*
* @param key Preset key.
* @returns list of document list presets
*/
getDocumentListPreset(key: string): DocumentListPresetRef[] {
return this.extensionService
@@ -66,6 +67,8 @@ export class AppExtensionService {
/**
* Provides a list of the Viewer content extensions,
* filtered by **disabled** state and **rules**.
*
* @returns list of viewer extension references
*/
getViewerExtensions(): ViewerExtensionRef[] {
return this.extensionService

View File

@@ -84,6 +84,11 @@ export class ExtensionLoaderService {
* Filters element by **enabled** and **order** attributes.
* Example:
* `getElements<ViewerExtensionRef>(config, 'features.viewer.content')`
*
* @param config configuration settings
* @param key element key
* @param fallback fallback array of values
* @returns list of elements
*/
getElements<T extends ExtensionElement>(
config: ExtensionConfig,

View File

@@ -28,6 +28,11 @@ import { ExtensionElement } from '../config/extension-element';
import { BehaviorSubject, Observable } from 'rxjs';
// eslint-disable-next-line prefer-arrow/prefer-arrow-functions
/**
* The default extensions factory
*
* @returns the list of extension json files
*/
export function extensionJsonsFactory() {
return [];
};
@@ -38,6 +43,12 @@ export const EXTENSION_JSONS = new InjectionToken<string[][]>('extension-jsons',
});
// eslint-disable-next-line prefer-arrow/prefer-arrow-functions
/**
* Provides the extension json values for the angular modules
*
* @param jsons files to provide
* @returns a provider section
*/
export function provideExtensionConfig(jsons: string[]) {
return {
provide: EXTENSION_JSONS,