From 33905fd69e5e0d2ecdc2d180f37ffe51f16f61fb Mon Sep 17 00:00:00 2001 From: Martin Chovanec Date: Fri, 7 Jul 2017 15:56:05 +0200 Subject: [PATCH] Fix JSDoc (#59) --- sacredboard/static/scripts/metricsPlot/component.js | 4 +++- .../static/scripts/runs/metricsViewer/ProxiedMetric.js | 6 +++--- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/sacredboard/static/scripts/metricsPlot/component.js b/sacredboard/static/scripts/metricsPlot/component.js index 120abc0..e70791d 100644 --- a/sacredboard/static/scripts/metricsPlot/component.js +++ b/sacredboard/static/scripts/metricsPlot/component.js @@ -15,7 +15,9 @@ define(["knockout", "text!./template.html", "plot/component", "runs/Metric"], /** * ViewModel of the metrics-plot component. * - * It holds all the metrics available, + * It holds all the metrics available, the metrics selected by + * the user to be plotted and calculates the actual series + * for the plot-chart component. * * @param {{availableMetrics}} params - Parameters of the viewModel. * @param {Metric[]} params.availableMetrics - Knockout observable array of {@link Metric}. diff --git a/sacredboard/static/scripts/runs/metricsViewer/ProxiedMetric.js b/sacredboard/static/scripts/runs/metricsViewer/ProxiedMetric.js index f9db326..2e277b8 100644 --- a/sacredboard/static/scripts/runs/metricsViewer/ProxiedMetric.js +++ b/sacredboard/static/scripts/runs/metricsViewer/ProxiedMetric.js @@ -77,14 +77,14 @@ define(["runs/Metric", "knockout", "jquery"], function (Metric, ko, $) { /** * Trigger when the metric couldn't be loaded. * - * @param textStatus - * @param error + * @param {string} textStatus - Status returned by the HTTP request. + * @param {string} error - Error type returned by the HTTP request. * @param {string} name - Name of the metric that have failed to load. */ onLoadFail(textStatus, error, name) { /* override the method if possible */ alert("Error when loading metric " + name + ".\nError message: " + textStatus + "\nError:" + error); - }; + } } return ProxiedMetric;