diff --git a/package.json b/package.json index 88b1628c76d4..f5e2c97b5fee 100644 --- a/package.json +++ b/package.json @@ -133,7 +133,7 @@ "editorconfig-checker": "5.1.8", "ejs-loader": "0.5.0", "eslint": "8.57.0", - "eslint-plugin-jsdoc": "39.9.1", + "eslint-plugin-jsdoc": "50.2.2", "eslint-plugin-lit": "1.14.0", "eslint-plugin-wc": "2.1.1", "event-hooks-webpack-plugin": "2.3.0", diff --git a/src/auth/FormElement.ts b/src/auth/FormElement.ts index 6b86f5a4dffa..ba7317eaab98 100644 --- a/src/auth/FormElement.ts +++ b/src/auth/FormElement.ts @@ -373,7 +373,6 @@ export default class GmfAuthForm extends GmfBaseElement { /** * Calls the authentication service changePassword method. - * * @param evt the event */ changePassword(evt: Event): void { @@ -457,7 +456,6 @@ export default class GmfAuthForm extends GmfBaseElement { /** * Calls the authentication service login method. - * * @param evt Event from the form submit action. */ login(evt: Event): void { @@ -503,7 +501,6 @@ export default class GmfAuthForm extends GmfBaseElement { /** * Calls the authentication service logout method. - * * @param evt Event from the form submit action. */ logout(evt: Event): void { @@ -536,7 +533,6 @@ export default class GmfAuthForm extends GmfBaseElement { /** * Calls the authentication service resetPassword method. - * * @param evt Event from the form submit action. */ resetPassword(evt: Event): void { @@ -591,8 +587,7 @@ export default class GmfAuthForm extends GmfBaseElement { } /** - * Set an error notification - * + * Set an error notification. * @param errors List of errors * @param messageType Type of message */ diff --git a/src/auth/service.ts b/src/auth/service.ts index 51e8868e8e8d..2c982b95597e 100644 --- a/src/auth/service.ts +++ b/src/auth/service.ts @@ -36,7 +36,6 @@ let userTransformer = (user: User) => user; /** * Method defined in the aim to be overridden. - * * @param fn The callback function to apply after login. */ export function setOnSuccessfulLoginFunction(fn: typeof userTransformer): void { @@ -66,14 +65,12 @@ export enum RouteSuffix { export class AuthenticationService { /** * The authentication url without trailing slash. - * * @private */ baseUrl_: string; /** * The user. - * * @private */ user_: User; @@ -81,7 +78,6 @@ export class AuthenticationService { /** * Don't request a new user object from the back-end after * logging out if the logged-in user's role has this role. - * * @private */ noReloadRole_: undefined | gmfOptionsGmfAuthenticationNoReloadRole; @@ -93,7 +89,6 @@ export class AuthenticationService { constructor() { /** * The authentication url without trailing slash. - * * @private */ this.baseUrl_ = null; @@ -111,7 +106,6 @@ export class AuthenticationService { /** * Don't request a new user object from the back-end after * logging out if the logged-in user's role has this role. - * * @private */ this.noReloadRole_ = null; @@ -137,7 +131,6 @@ export class AuthenticationService { /** * Check whether the user is connected or not like on load. - * * @private */ checkConnection_(): void { @@ -165,7 +158,6 @@ export class AuthenticationService { /** * Load the authentication service, which sends an async request to * determine whether the user is currently connected or not. - * * @private */ load_(): void { @@ -262,7 +254,6 @@ export class AuthenticationService { /** * Check the user to have a user with all parameters in all cases. - * * @param data Ajax response. * @returns Response. */ diff --git a/src/canvas/DesktopElement.ts b/src/canvas/DesktopElement.ts index 0dcc40075696..13d1d60eada4 100644 --- a/src/canvas/DesktopElement.ts +++ b/src/canvas/DesktopElement.ts @@ -503,8 +503,7 @@ export default class GmfDesktopCanvas extends BaseElement { /** * Panel resizing: - * Store initial mouse position, listen to drag event and resize elements - * + * Store initial mouse position, listen to drag event and resize elements. * @param {PanelResize} panelResizeEvent Interface to store the details of the drag event * @param {HTMLElement} separator Element separating the elements to resize * @param {HTMLElement} leftElement Left element to resize @@ -540,8 +539,7 @@ export default class GmfDesktopCanvas extends BaseElement { /** * Panel resizing: - * Compute drag offset, change element position or width accordingly - * + * Compute drag offset, change element position or width accordingly. * @param {PanelResize} panelResizeEvent Interface to store the details of the mouse down event * @returns {MouseEvent} The drag event */ @@ -598,7 +596,6 @@ export default class GmfDesktopCanvas extends BaseElement { /** * Resize the data (left) panel when dragging the separator - * * @param {MouseEvent} event The mouse down event * @param {ShadowRoot} desktopCanvas The desktop canvas * @returns {MouseEvent} The mouse down event @@ -616,7 +613,6 @@ export default class GmfDesktopCanvas extends BaseElement { /** * Resize the tool (right) panel when dragging the separator - * * @param {MouseEvent} event The mouse down event * @param {ShadowRoot} desktopCanvas The desktop canvas * @returns {MouseEvent} The mouse down event diff --git a/src/download/Csv.ts b/src/download/Csv.ts index 74fbc5a3894e..cf0123f11f85 100644 --- a/src/download/Csv.ts +++ b/src/download/Csv.ts @@ -67,7 +67,6 @@ export class DownloadCsvService { /** * Generate a CSV. - * * @param {Object[]} data Entries/objects to include in the CSV. * @param {GridColumnDef[]} columnDefs Column definitions. * @returns {string} The CSV file as string. @@ -116,7 +115,6 @@ export class DownloadCsvService { /** * Generate a CSV and start a download with the generated file. - * * @param {Object[]} data Entries/objects to include in the CSV. * @param {GridColumnDef[]} columnDefs Column definitions. * @param {string} fileName The CSV file name, without the extension. diff --git a/src/download/service.ts b/src/download/service.ts index e1ae2d80f405..24e89496149a 100644 --- a/src/download/service.ts +++ b/src/download/service.ts @@ -24,7 +24,6 @@ import {saveAs} from 'file-saver'; /** * A function to start a download for a file. - * * @param {string} content The content of the file to download. * @param {string} fileName The name of the file to download. * @param {string | undefined} opt_fileType The type of the file to download. diff --git a/src/lidar/Config.ts b/src/lidar/Config.ts index 34c0deafe58e..984ba0dacc78 100644 --- a/src/lidar/Config.ts +++ b/src/lidar/Config.ts @@ -213,8 +213,7 @@ export class LidarprofileConfigService { } /** - * Initialize the service variables from Pytree profile_config_gmf2 route - * + * Initialize the service variables from Pytree profile_config_gmf2 route. * @returns Promise The server configuration. */ initProfileConfig(): Promise { diff --git a/src/lidar/Manager.ts b/src/lidar/Manager.ts index 9e553e8f9953..7861c9b864a3 100644 --- a/src/lidar/Manager.ts +++ b/src/lidar/Manager.ts @@ -81,23 +81,23 @@ export class LidarprofileManager { map_: undefined | OlMap; /** - * The hovered point attributes in D3 profile highlighted on the 2D map + * The hovered point attributes in D3 profile highlighted on the 2D map. */ cartoHighlight: OlOverlay; /** - * The hovered point geometry (point) in D3 profile highlighted on the 2D map + * The hovered point geometry (point) in D3 profile highlighted on the 2D map. */ lidarPointHighlight: OlLayerVector>; /** * The profile footpring represented as a LineString represented - * with real mapunites stroke width + * with real mapunites stroke width. */ lidarBuffer: OlLayerVector>; /** - * The variable where all points of the profile are stored + * The variable where all points of the profile are stored. */ profilePoints: GmfLidarprofileUtilsLidarprofilePoints; @@ -118,7 +118,7 @@ export class LidarprofileManager { debouncer = debounce(() => this.updateData_(), 200); /** * Provides a service to manage a D3js component to be used to draw an lidar point cloud profile chart. - * Requires access to a Pytree webservice: https://github.com/sitn/pytree + * Requires access to a Pytree webservice: https://github.com/sitn/pytree. */ constructor() { /** @@ -138,7 +138,7 @@ export class LidarprofileManager { this.map_ = null; /** - * The hovered point attributes in D3 profile highlighted on the 2D map + * The hovered point attributes in D3 profile highlighted on the 2D map. */ this.cartoHighlight = new olOverlay({ offset: [0, -15], @@ -146,7 +146,7 @@ export class LidarprofileManager { }); /** - * The hovered point geometry (point) in D3 profile highlighted on the 2D map + * The hovered point geometry (point) in D3 profile highlighted on the 2D map. */ this.lidarPointHighlight = new olLayerVector({ className: 'canvas2d', @@ -163,7 +163,7 @@ export class LidarprofileManager { /** * The profile footpring represented as a LineString represented - * with real mapunites stroke width + * with real mapunites stroke width. */ this.lidarBuffer = new olLayerVector({ className: 'canvas2d', @@ -171,7 +171,7 @@ export class LidarprofileManager { }); /** - * The variable where all points of the profile are stored + * The variable where all points of the profile are stored. */ this.profilePoints = this.getEmptyProfilePoints_(); @@ -200,7 +200,7 @@ export class LidarprofileManager { } /** - * Clears the profile footprint + * Clears the profile footprint. */ clearBuffer(): void { if (this.lidarBuffer) { @@ -211,8 +211,7 @@ export class LidarprofileManager { } /** - * Set the line for the profile - * + * Set the line for the profile. * @param line that defines the profile */ setLine(line: undefined | OlGeomLineString): void { @@ -220,8 +219,7 @@ export class LidarprofileManager { } /** - * Set the map used by the profile - * + * Set the map used by the profile. * @param map The map. */ setMap(map: OlMap): void { @@ -247,8 +245,7 @@ export class LidarprofileManager { } /** - * Load profile data (lidar points) by successive Levels Of Details using asynchronous requests - * + * Load profile data (lidar points) by successive Levels Of Details using asynchronous requests. * @param clippedLine an array of the clipped line coordinates * @param distanceOffset the left side of D3 profile domain at current zoom and pan configuration * @param resetPlot whether to reset D3 plot or not @@ -356,8 +353,7 @@ export class LidarprofileManager { } /** - * Request to Pytree service for a range of Level Of Detail (LOD) - * + * Request to Pytree service for a range of Level Of Detail (LOD). * @param minLOD minimum Level Of Detail of the request * @param maxLOD maximum Level Of Detail of the request * @param iter the iteration in profile requests cycle @@ -430,8 +426,7 @@ export class LidarprofileManager { } /** - * Process the binary array return by Pytree (cPotree) - * + * Process the binary array return by Pytree (cPotree). * @param profile binary array returned by cPotree executable called by Pytree * @param iter the iteration in profile requests cycle * @param distanceOffset the left side of D3 profile domain at current zoom and pan configuration @@ -609,8 +604,7 @@ export class LidarprofileManager { } /** - * Callback method used by the debouncer to update the profile data - * + * Callback method used by the debouncer to update the profile data. * @private */ updateData_(): void { diff --git a/src/lidar/Measure.ts b/src/lidar/Measure.ts index 59ce1c54e867..1213c5f24aa5 100644 --- a/src/lidar/Measure.ts +++ b/src/lidar/Measure.ts @@ -45,8 +45,7 @@ export default class { pEnd_: GmfLidarprofileUtilsLidarPoint; /** - * Measure tool for the d3 chart - * + * Measure tool for the d3 chart. * @param gmfLidarprofileManagerInstance * gmf lidar profile manager instance */ @@ -68,7 +67,7 @@ export default class { } /** - * Clear the current measure + * Clear the current measure. */ clearMeasure(): void { this.pStart_ = {}; @@ -92,7 +91,7 @@ export default class { } /** - * Activate the measure tool + * Activate the measure tool. */ setMeasureActive(): void { const svg = d3select( @@ -106,7 +105,6 @@ export default class { /** * Measure and display height after two click on the profile. - * * @param event Event . */ measureHeight(event: MouseEvent): void { diff --git a/src/lidar/PanelElement.ts b/src/lidar/PanelElement.ts index 75cc05f589a9..c51a3d375c04 100644 --- a/src/lidar/PanelElement.ts +++ b/src/lidar/PanelElement.ts @@ -253,7 +253,6 @@ export default class GmfLidarPanel extends ToolPanelElement { /** * Toggle visibility of the selected classification object. - * * @param classification The classification to change visibility. * @param key The key string of the toggled classification. */ @@ -263,7 +262,7 @@ export default class GmfLidarPanel extends ToolPanelElement { } /** - * Set visible the selected point attribute option + * Set visible the selected point attribute option. */ selectPointAttribute(): void { const selectElement = this.renderRoot.querySelector('#select-attributes'); @@ -334,7 +333,7 @@ export default class GmfLidarPanel extends ToolPanelElement { this.resetPlot(); } /** - * Activate the measure tool + * Activate the measure tool. */ setMeasureActive(): void { if (!this.profile.measure) { @@ -345,7 +344,7 @@ export default class GmfLidarPanel extends ToolPanelElement { } /** - * Clear the current measure + * Clear the current measure. */ clearMeasure(): void { if (!this.profile.measure) { @@ -355,7 +354,7 @@ export default class GmfLidarPanel extends ToolPanelElement { } /** - * Reload and reset the plot for the current profile (reloads data) + * Reload and reset the plot for the current profile (reloads data). */ resetPlot(): void { this.profile.clearBuffer(); @@ -366,7 +365,6 @@ export default class GmfLidarPanel extends ToolPanelElement { /** * Get all available point attributes. - * * @returns Available point attributes. */ getAvailablePointAttributes(): LidarprofileServerConfigPointAttributes[] | undefined { @@ -374,8 +372,7 @@ export default class GmfLidarPanel extends ToolPanelElement { } /** - * Set the selected point attribute - * + * Set the selected point attribute. * @param {LidarprofileServerConfigPointAttribute} selectedPointAttribute The new selected point attribute. */ setSelectedPointAttribute(selectedPointAttribute: LidarprofileServerConfigPointAttribute): void { @@ -384,8 +381,7 @@ export default class GmfLidarPanel extends ToolPanelElement { } /** - * Get the available classifications for this dataset - * + * Get the available classifications for this dataset. * @returns classification list */ getClassification(): LidarprofileServerConfigClassifications { @@ -396,8 +392,7 @@ export default class GmfLidarPanel extends ToolPanelElement { } /** - * Sets the visible classification in the profile - * + * Sets the visible classification in the profile. * @param classification selected value. * @param key of the classification code. */ diff --git a/src/lidar/Plot.ts b/src/lidar/Plot.ts index bb30dbad8519..eca67d79d0ed 100644 --- a/src/lidar/Plot.ts +++ b/src/lidar/Plot.ts @@ -101,7 +101,6 @@ export default class { /** * Provides a service to create an SVG element with defined axis and a LIDAR * point drawing mechanism. - * * @param gmfLidarprofileManagerInstance * gmf lidar profile manager instance */ @@ -118,7 +117,6 @@ export default class { /** * d3.scaleLinear X scale. - * * @param x . * @returns x . */ @@ -131,14 +129,13 @@ export default class { /** * d3.scaleLinear Y scale. - * * @param y . * @returns y . */ this.updateScaleY = (y) => y; /** - * The material used for the drawing process. Initialized in the setup + * The material used for the drawing process. Initialized in the setup. */ this.material = null; @@ -161,8 +158,7 @@ export default class { } /** - * Draw the points to the canvas element - * + * Draw the points to the canvas element. * @param points of the profile */ drawPoints(points: GmfLidarprofileUtilsLidarprofilePoints): void { @@ -219,8 +215,7 @@ export default class { } /** - * Setup the SVG components of the D3 chart - * + * Setup the SVG components of the D3 chart. * @param rangeX range of the x scale * @param rangeY range of the y scale */ @@ -354,8 +349,7 @@ export default class { } /** - * Update the plot data at the end of the zoom process - * + * Update the plot data at the end of the zoom process. * @param event Event . */ // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types @@ -380,8 +374,7 @@ export default class { } /** - * Update the plot axis during the zoom process - * + * Update the plot axis during the zoom process. * @param event Event . */ // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types @@ -438,8 +431,7 @@ export default class { } /** - * Update the OpenLayers overlay that displays point position and attributes values - * + * Update the OpenLayers overlay that displays point position and attributes values. * @param event Event . */ pointHighlight(event: MouseEvent): void { @@ -579,8 +571,7 @@ export default class { } /** - * Change the profile style according to the material color - * + * Change the profile style according to the material color. * @param material value as defined in Pytree attribute configuration */ changeStyle(material: string): void { @@ -600,8 +591,7 @@ export default class { } /** - * Show/Hide classes in the profile - * + * Show/Hide classes in the profile. * @param classification * value as defined in the Pytree classification_colors configuration * @param material value as defined in Pytree attribute configuration diff --git a/src/lidar/Utils.ts b/src/lidar/Utils.ts index 00f23e3b96f8..570e8bcb8b86 100644 --- a/src/lidar/Utils.ts +++ b/src/lidar/Utils.ts @@ -43,7 +43,7 @@ import {updateScaleFunction} from 'ngeo/lidar/Plot'; import i18next from 'i18next'; /** - * The lidar point attribute list width default option + * The lidar point attribute list width default option. */ type LidarPointAttributeList = { availableOptions?: LidarprofileServerConfigPointAttributes[]; @@ -52,7 +52,7 @@ type LidarPointAttributeList = { }; /** - * The object containing all points in profile + * The object containing all points in profile. */ export type LidarprofileClientConfig = { autoWidth?: boolean; @@ -67,7 +67,7 @@ export type LidarprofileClientConfig = { }; /** - * The object containing all points in profile + * The object containing all points in profile. */ export type LidarprofilePoints = { distance?: number[]; @@ -79,7 +79,7 @@ export type LidarprofilePoints = { }; /** - * Profile point after measure or after parsing of the binary array returned by Pytree + * Profile point after measure or after parsing of the binary array returned by Pytree. */ export type LidarPoint = { cx?: number | undefined; @@ -108,8 +108,7 @@ type NiceLOD = { export default class { onload: () => void; /** - * Clip a linestring with start and end measure given by D3 Chart domain - * + * Clip a linestring with start and end measure given by D3 Chart domain. * @param config the LIDAR profile config * instance * @param map_resolution the current resolution of the map @@ -247,8 +246,7 @@ export default class { /** * Get a Level Of Details and with for a given chart span - * Configuration is set up in Pytree configuration - * + * Configuration is set up in Pytree configuration. * @param span domain extent * @param max_levels levels defined * by a LIDAR server @@ -272,7 +270,6 @@ export default class { /** * Create a image file by combining SVG and canvas elements and let the user downloads it. - * * @param profileClientConfig The profile client configuration. */ downloadProfileAsImageFile(profileClientConfig: LidarprofileClientConfig): void { @@ -340,7 +337,6 @@ export default class { /** * Transforms a lidarprofile into multiple single points sorted by distance. - * * @param profilePoints in the profile * @returns An array of LIDAR Points. */ @@ -363,7 +359,6 @@ export default class { /** * Get the data for a CSV export of the profile. - * * @param points A list of lidar profile point objects. * @returns Objects for a csv export (column: value). */ @@ -389,8 +384,7 @@ export default class { } /** - * Find the maximum value in am array of numbers - * + * Find the maximum value in am array of numbers. * @param array of number * @returns the maximum of input array */ @@ -399,8 +393,7 @@ export default class { } /** - * Find the minimum value in am array of numbers - * + * Find the minimum value in am array of numbers. * @param array of number * @returns the minimum of input array */ @@ -415,8 +408,7 @@ export default class { } /** - * Transform OpenLayers linestring into a cPotree compatible definition - * + * Transform OpenLayers linestring into a cPotree compatible definition. * @param line the profile 2D line * @returns linestring in a cPotree/pytree compatible string definition */ @@ -432,8 +424,7 @@ export default class { } /** - * Find the profile's closest point in profile data to the chart mouse position - * + * Find the profile's closest point in profile data to the chart mouse position. * @param points Object containing points properties as arrays * @param xs mouse x coordinate on canvas element * @param ys mouse y coordinate on canvas element diff --git a/src/lidar/line.ts b/src/lidar/line.ts index 50be17264d1c..f46330dca790 100644 --- a/src/lidar/line.ts +++ b/src/lidar/line.ts @@ -1,6 +1,6 @@ // The MIT License (MIT) // -// Copyright (c) 2022 Camptocamp SA +// Copyright (c) 2022-2024 Camptocamp SA // // Permission is hereby granted, free of charge, to any person obtaining a copy of // this software and associated documentation files (the "Software"), to deal in @@ -39,14 +39,12 @@ import OlGeomLineString from 'ol/geom/LineString'; export class LineModel { /** * The observable line's properties. - * * @private */ line_: BehaviorSubject = new BehaviorSubject(null); /** - * Get the lines - * + * Get the lines. * @returns {BehaviorSubject} The existing line. */ getLine(): BehaviorSubject { @@ -55,7 +53,6 @@ export class LineModel { /** * Set the line. - * * @param line The line */ setLine(line: OlGeomLineString): void { diff --git a/src/map/FeatureOverlay.ts b/src/map/FeatureOverlay.ts index 8c5ccb094c19..abb2231de18b 100644 --- a/src/map/FeatureOverlay.ts +++ b/src/map/FeatureOverlay.ts @@ -36,7 +36,6 @@ import OlEventsEvent from 'ol/events/Event'; * * Example of initialization: * const featureOverlay = new FeatureOverlay(manager, index); - * * @param {NgeoMapFeatureOverlayMgrFeatureOverlayMgr} manager The feature overlay manager. * @param {number} index This feature overlay's index. */ @@ -55,7 +54,6 @@ export class FeatureOverlay { /** * Add a feature to the feature overlay. - * * @param {OlFeature} feature The feature to add. */ addFeature(feature: OlFeature): void { @@ -64,7 +62,6 @@ export class FeatureOverlay { /** * Remove a feature from the feature overlay. - * * @param {OlFeature} feature The feature to remove. */ removeFeature(feature: OlFeature): void { @@ -73,7 +70,6 @@ export class FeatureOverlay { /** * Check if featureOverlay has no features. - * * @returns {boolean} True if there is no features. False otherwise. */ isEmpty(): boolean { @@ -93,7 +89,6 @@ export class FeatureOverlay { * configure the feature overlay with a feature collection you will use the * collection to add and remove features instead of using the overlay's * `addFeature`, `removeFeature` and `clear` functions. - * * @param {OlCollection>} features Feature collection. */ setFeatures(features: OlCollection>): void { @@ -118,7 +113,6 @@ export class FeatureOverlay { /** * Set a style for the feature overlay. - * * @param {OlStyleStyle | OlStyleStyle[] | OlStyleStyleStyleFunction} style Style. */ setStyle(style: OlStyleStyle | OlStyleStyle[] | OlStyleStyleStyleFunction): void { diff --git a/src/message/Message.ts b/src/message/Message.ts index 3e1318ee2e10..a2ade9b1b7e9 100644 --- a/src/message/Message.ts +++ b/src/message/Message.ts @@ -55,14 +55,12 @@ export enum MessageType { /** * Abstract class for services that display messages. - * * @class * @abstract */ export default class { /** * Show the message. - * * @abstract * @param message Message. * @protected @@ -73,7 +71,6 @@ export default class { /** * Show disclaimer message string or object or list of disclame message * strings or objects. - * * @param object A message or list of messages as text or configuration objects. */ show(object: string | Message | (string | Message)[]): void { @@ -83,7 +80,6 @@ export default class { /** * Display the given error message or list of error messages. - * * @param message Message or list of messages. */ error(message: string | string[]): void { @@ -92,7 +88,6 @@ export default class { /** * Display the given info message or list of info messages. - * * @param message Message or list of messages. */ info(message: string | string[]): void { @@ -101,7 +96,6 @@ export default class { /** * Display the given success message or list of success messages. - * * @param message Message or list of messages. */ success(message: string | string[]): void { @@ -110,7 +104,6 @@ export default class { /** * Display the given warning message or list of warning messages. - * * @param message Message or list of messages. */ warn(message: string | string[]): void { @@ -122,7 +115,6 @@ export default class { * message strings, message object or list message objects. The type can be * overridden here as well OR defined (if the message(s) is/are string(s), * defaults to 'information'). - * * @param object * A message or list of messages as text or configuration objects. * @param opt_type The type of message to override the messages with. diff --git a/src/message/Notification.ts b/src/message/Notification.ts index 619ff4a1ec4f..bf132a7a42c7 100644 --- a/src/message/Notification.ts +++ b/src/message/Notification.ts @@ -26,7 +26,6 @@ import {getUid as olUtilGetUid} from 'ol/util'; /** * Default delay (in milliseconds) a message should be displayed. - * * @private */ const DEFAULT_DELAY = 7000; @@ -40,7 +39,6 @@ type CacheItem = { * Provides methods to display any sort of messages, notifications, errors, * etc. Requires Bootstrap library (both CSS and JS) to display the alerts * properly. - * * @abstract */ export class MessageNotification extends ngeoMessageMessage { @@ -82,7 +80,6 @@ export class MessageNotification extends ngeoMessageMessage { /** * Display the given message string or object or list of message strings or * objects. - * * @param object * A message or list of messages as text or configuration objects. */ @@ -162,7 +159,6 @@ export class MessageNotification extends ngeoMessageMessage { /** * Clear a message using its cache item. - * * @param item Cache item. * @private */ diff --git a/src/profile/d3Elevation.ts b/src/profile/d3Elevation.ts index b0486cc5c619..c38f0dfd7da9 100644 --- a/src/profile/d3Elevation.ts +++ b/src/profile/d3Elevation.ts @@ -106,7 +106,6 @@ type scaleModifierFunction = { * "x": 541620 * }, ... * ] - * * @param {ngeoOptionsNgeoProfileOptions} options Profile options. * @param {NgeoProfileElevationComponentProfileOptions} functions Profile options. * @returns D3js component. @@ -485,8 +484,7 @@ function d3Elevation( g.select('.overlay').on('mouseout', mouseout).on('mousemove', mousemove); /** - * Generate the highlight from the mouse position - * + * Generate the highlight from the mouse position. * @param event Event */ function mousemove(event: Event): void { @@ -518,7 +516,6 @@ function d3Elevation( /** * Highlight the given distance and corresponding elevation on chart. * Fire the hoverCallback callback with corresponding point. - * * @param {number} distance Distance. */ profile.highlight = function (distance: number) {