From b50add1b98acb23c92812227f4bf684a50d6b6ed Mon Sep 17 00:00:00 2001 From: Piotr Gawron <piotr.gawron@uni.lu> Date: Mon, 30 Apr 2018 14:44:31 +0200 Subject: [PATCH] JSdoc fixed --- frontend-js/src/main/js/gui/AbstractGuiElement.js | 7 +++++++ frontend-js/src/main/js/gui/Panel.js | 15 +++++++++++++++ .../main/js/gui/admin/ChooseAnnotatorsDialog.js | 2 +- .../src/main/js/gui/leftPanel/AbstractDbPanel.js | 11 +++++++++++ .../src/main/js/gui/leftPanel/ChemicalPanel.js | 7 ++++++- 5 files changed, 40 insertions(+), 2 deletions(-) diff --git a/frontend-js/src/main/js/gui/AbstractGuiElement.js b/frontend-js/src/main/js/gui/AbstractGuiElement.js index f2817d3a39..970d335640 100644 --- a/frontend-js/src/main/js/gui/AbstractGuiElement.js +++ b/frontend-js/src/main/js/gui/AbstractGuiElement.js @@ -7,6 +7,13 @@ var PanelControlElementType = require('./PanelControlElementType'); var logger = require('../logger'); +/** + * + * @param params + * @constructor + * + * @extends ObjectWithListeners + */ function AbstractGuiElement(params) { ObjectWithListeners.call(this, params); diff --git a/frontend-js/src/main/js/gui/Panel.js b/frontend-js/src/main/js/gui/Panel.js index e58b7684da..5d9f683e95 100644 --- a/frontend-js/src/main/js/gui/Panel.js +++ b/frontend-js/src/main/js/gui/Panel.js @@ -11,6 +11,21 @@ var Functions = require('../Functions'); var logger = require('../logger'); var xss = require('xss'); +/** + * + * @param {Configuration} [params.configuration] + * @param {HTMLElement} params.element + * @param {Project} params.project + * @param {CustomMap} params.customMap + * @param {string} params.panelName + * @param {boolean} params.scrollable + * @param {string} [params.helpTip] + * @param params.parent + * + * @constructor + * @extends AbstractGuiElement + */ + function Panel(params) { AbstractGuiElement.call(this, params); diff --git a/frontend-js/src/main/js/gui/admin/ChooseAnnotatorsDialog.js b/frontend-js/src/main/js/gui/admin/ChooseAnnotatorsDialog.js index 2282b96c74..b0c74fefee 100644 --- a/frontend-js/src/main/js/gui/admin/ChooseAnnotatorsDialog.js +++ b/frontend-js/src/main/js/gui/admin/ChooseAnnotatorsDialog.js @@ -317,7 +317,7 @@ ChooseAnnotatorsDialog.prototype.setElementType = function (elementType) { }); paramValue.checked = (existingParamValue && existingParamValue === 'true'); } else { - throw new InvalidAlgorithmError("Unknown annotator parameter type"); + throw new Error("Unknown annotator parameter type"); } paramElement.appendChild(paramValue); diff --git a/frontend-js/src/main/js/gui/leftPanel/AbstractDbPanel.js b/frontend-js/src/main/js/gui/leftPanel/AbstractDbPanel.js index aa1d37c4c2..73fa48f126 100644 --- a/frontend-js/src/main/js/gui/leftPanel/AbstractDbPanel.js +++ b/frontend-js/src/main/js/gui/leftPanel/AbstractDbPanel.js @@ -11,6 +11,13 @@ var PanelControlElementType = require('../PanelControlElementType'); var logger = require('../../logger'); var Functions = require('../../Functions'); +/** + * + * @param {string} params.placeholder + * @param {string} params.panelName + * @constructor + * @extends Panel + */ function AbstractPanel(params) { Panel.call(this, params); var self = this; @@ -170,6 +177,10 @@ AbstractPanel.prototype.setOverlayDb = function (overlayDb) { this._overlayDb = overlayDb; }; +/** + * + * @returns {AbstractDbOverlay} + */ AbstractPanel.prototype.getOverlayDb = function () { return this._overlayDb; }; diff --git a/frontend-js/src/main/js/gui/leftPanel/ChemicalPanel.js b/frontend-js/src/main/js/gui/leftPanel/ChemicalPanel.js index 35d60913fe..daff6715ab 100644 --- a/frontend-js/src/main/js/gui/leftPanel/ChemicalPanel.js +++ b/frontend-js/src/main/js/gui/leftPanel/ChemicalPanel.js @@ -9,7 +9,12 @@ var logger = require('../../logger'); var AbstractDbPanel = require('./AbstractDbPanel'); var PanelControlElementType = require('../PanelControlElementType'); - +/** + * + * @param params + * @constructor + * @extends AbstractDbPanel + */ function ChemicalPanel(params) { var self = this; params.panelName = "chemical"; -- GitLab