From 215115dfaf76ff46700bf546dd48e107e9f92300 Mon Sep 17 00:00:00 2001
From: Piotr Gawron <piotr.gawron@uni.lu>
Date: Thu, 19 Jul 2018 09:31:28 +0200
Subject: [PATCH] js doc updated

---
 frontend-js/src/main/js/Functions.js          |  5 +-
 frontend-js/src/main/js/ServerConnector.js    | 83 +++++++++++++++++--
 .../src/main/js/map/surface/AliasSurface.js   |  6 +-
 3 files changed, 83 insertions(+), 11 deletions(-)

diff --git a/frontend-js/src/main/js/Functions.js b/frontend-js/src/main/js/Functions.js
index b04ce60a4f..8151073b37 100644
--- a/frontend-js/src/main/js/Functions.js
+++ b/frontend-js/src/main/js/Functions.js
@@ -199,12 +199,14 @@ Functions.isDomElement = function (o) {
 };
 
 /**
+ *
+ * @param {LayoutAlias|LayoutReaction} elementOverlay
  *
  * @returns {Promise<string>}
  */
+
 Functions.overlayToColor = function (elementOverlay) {
   var self = this;
-  /* jslint bitwise: true */
   if (elementOverlay === null || elementOverlay === undefined) {
     return Promise.reject("elementOverlay cannot be null!");
   } else if (elementOverlay.color !== undefined && elementOverlay.color !== null) {
@@ -633,4 +635,5 @@ Functions.computeMD5 = function (s) {
   var i = B(Y) + B(X) + B(W) + B(V);
   return i.toLowerCase()
 };
+
 module.exports = Functions;
diff --git a/frontend-js/src/main/js/ServerConnector.js b/frontend-js/src/main/js/ServerConnector.js
index 271aeb78f6..4d042328a0 100644
--- a/frontend-js/src/main/js/ServerConnector.js
+++ b/frontend-js/src/main/js/ServerConnector.js
@@ -159,7 +159,7 @@ function isSessionExpiredError(error) {
 /**
  *
  * @param params
- * @returns {PromiseLike}
+ * @returns {PromiseLike|Promise}
  */
 ServerConnector.sendRequest = function (params) {
   var self = this;
@@ -231,6 +231,12 @@ ServerConnector._sendRequest = function (params) {
   });
 };
 
+/**
+ *
+ * @param {string} url
+ * @param {Object} params
+ * @returns {Promise}
+ */
 ServerConnector.sendPostRequest = function (url, params) {
   return this.sendRequest({
     method: "POST",
@@ -320,8 +326,8 @@ ServerConnector.createGetParams = function (params, prefix) {
 /**
  *
  * @param {Object} paramObj
- * @param {string} paramObj.type
- * @param {string} [paramObj.url]
+ * @param {string} [paramObj.type]
+ * @param {string} paramObj.url
  * @param {Object} [paramObj.params]
  *
  * @returns {string}
@@ -1200,8 +1206,13 @@ ServerConnector.updateUser = function (user) {
   }).then(function (configuration) {
     return self.updateUserPrivileges({user: user, privileges: user.privilegesToExport(configuration)});
   });
-
 };
+
+/**
+ *
+ * @param {User} user
+ * @returns {Promise}
+ */
 ServerConnector.addUser = function (user) {
   var self = this;
   var queryParams = {
@@ -1219,18 +1230,29 @@ ServerConnector.addUser = function (user) {
   }).then(function (configuration) {
     return self.updateUserPrivileges({user: user, privileges: user.privilegesToExport(configuration)});
   });
-
 };
 
+/**
+ *
+ * @param {string} login
+ * @returns {Promise}
+ */
 ServerConnector.removeUser = function (login) {
   var self = this;
   var queryParams = {
     login: login
   };
   return self.sendDeleteRequest(self.getUserUrl(queryParams));
-
 };
 
+/**
+ *
+ * @param {Object} params
+ * @param {User} params.user
+ * @param {Object} params.privileges
+ *
+ * @returns {Promise}
+ */
 ServerConnector.updateUserPrivileges = function (params) {
   var self = this;
   var queryParams = {
@@ -1253,6 +1275,11 @@ ServerConnector.updateUserPrivileges = function (params) {
   });
 };
 
+/**
+ *
+ * @param {Error} error
+ * @returns {Promise}
+ */
 ServerConnector.processNetworkError = function (error) {
   if ((error instanceof NetworkError)) {
     switch (error.statusCode) {
@@ -1268,7 +1295,14 @@ ServerConnector.processNetworkError = function (error) {
   }
 };
 
-
+/**
+ *
+ * @param {Object} params
+ * @param {User} params.user
+ * @param {UserPreferences} params.preferences
+ *
+ * @returns {Promise}
+ */
 ServerConnector.updateUserPreferences = function (params) {
   var self = this;
   var queryParams = {
@@ -1289,6 +1323,12 @@ ServerConnector.updateUserPreferences = function (params) {
   });
 };
 
+/**
+ *
+ * @param {boolean} forceRefresh
+ *
+ * @returns {Promise}
+ */
 ServerConnector.getUsers = function (forceRefresh) {
   var self = this;
 
@@ -1314,6 +1354,10 @@ ServerConnector.getUsers = function (forceRefresh) {
   }
 };
 
+/**
+ *
+ * @returns {Promise<Array>}
+ */
 ServerConnector.getReferenceGenomes = function () {
   var self = this;
 
@@ -1328,7 +1372,15 @@ ServerConnector.getReferenceGenomes = function () {
   });
 };
 
-
+/**
+ *
+ * @param {Object} [params]
+ * @param {string} [params.creator] user login
+ * @param {boolean} [params.publicOverlay]
+ * @param {string} [params.projectId]
+ *
+ * @returns {Promise<Array>}
+ */
 ServerConnector.getOverlays = function (params) {
   var self = this;
   if (params === undefined) {
@@ -1353,6 +1405,13 @@ ServerConnector.getOverlays = function (params) {
   });
 };
 
+/**
+ *
+ * @param {number} overlayId
+ * @param {string} [projectId]
+ *
+ * @returns {Promise}
+ */
 ServerConnector.getOverlayElements = function (overlayId, projectId) {
   var self = this;
   if (overlayId === undefined) {
@@ -1410,6 +1469,11 @@ ServerConnector.getFullOverlayElement = function (params) {
   });
 };
 
+/**
+ *
+ * @param {string} [projectId]
+ * @returns {Promise}
+ */
 ServerConnector.getProjectId = function (projectId) {
   var self = this;
   if (projectId !== undefined && projectId !== null && projectId !== "") {
@@ -2154,7 +2218,8 @@ ServerConnector.getReferenceGenome = function (params) {
  * @param {string|number} params.genomeId
  * @param {string} params.mappingName
  * @param {string} params.mappingUrl
- * @returns {PromiseLike}
+ *
+ * @returns {Promise}
  */
 ServerConnector.addGeneMapping = function (params) {
   var self = this;
diff --git a/frontend-js/src/main/js/map/surface/AliasSurface.js b/frontend-js/src/main/js/map/surface/AliasSurface.js
index f7dc2968bc..ed320c5b8e 100644
--- a/frontend-js/src/main/js/map/surface/AliasSurface.js
+++ b/frontend-js/src/main/js/map/surface/AliasSurface.js
@@ -140,6 +140,10 @@ AliasSurface.prototype.setStrokeOpacity = function (opacity) {
   this._strokeOpacity = opacity;
 };
 
+/**
+ *
+ * @returns {number}
+ */
 AliasSurface.prototype.getStrokeOpacity = function () {
   return this._strokeOpacity;
 };
@@ -180,7 +184,7 @@ AliasSurface.prototype.init = function () {
 
   var bounds = new Bounds(pointA, pointB);
   var fillOpacity;
-  return ServerConnector.getConfigurationParam(ConfigurationType.OVERLAY_OPACITY).then(function (result) {
+  return map.getServerConnector().getConfigurationParam(ConfigurationType.OVERLAY_OPACITY).then(function (result) {
     fillOpacity = self.getFillOpacity();
     if (fillOpacity === undefined) {
       fillOpacity = result;
-- 
GitLab