From 122a7f17e211173c8ab162e5db93c80d2e37d2eb Mon Sep 17 00:00:00 2001 From: Brenda Wallace Date: Wed, 3 Jan 2018 13:00:09 +1300 Subject: [PATCH] Fix up JSDoc --- app/assets/javascripts/graphs/bar_group.js | 2 +- app/assets/javascripts/graphs/height_scale.js | 1 + app/assets/javascripts/graphs/horizontal_bar_graph.js | 2 +- app/assets/javascripts/graphs/width_scale.js | 2 +- 4 files changed, 4 insertions(+), 3 deletions(-) diff --git a/app/assets/javascripts/graphs/bar_group.js b/app/assets/javascripts/graphs/bar_group.js index 312fcd6f3..cb6bf0ef6 100644 --- a/app/assets/javascripts/graphs/bar_group.js +++ b/app/assets/javascripts/graphs/bar_group.js @@ -15,7 +15,7 @@ /** * data object for bar group - * @param {int} data The graph data + * @param {Object} graph configuration */ function BarGroup(data) { this._data = data; diff --git a/app/assets/javascripts/graphs/height_scale.js b/app/assets/javascripts/graphs/height_scale.js index 8abc636c9..c4034a349 100644 --- a/app/assets/javascripts/graphs/height_scale.js +++ b/app/assets/javascripts/graphs/height_scale.js @@ -12,6 +12,7 @@ the svg /** * new heighscale object + * @param {Object} data Graph configuration */ function HeightScale(data) { this._data = data; diff --git a/app/assets/javascripts/graphs/horizontal_bar_graph.js b/app/assets/javascripts/graphs/horizontal_bar_graph.js index 856bca885..12dcae588 100644 --- a/app/assets/javascripts/graphs/horizontal_bar_graph.js +++ b/app/assets/javascripts/graphs/horizontal_bar_graph.js @@ -19,7 +19,7 @@ The main dimensions of the graph are rendered here. /** * create a new graph object - * @param {??} bar graph data + * @param {Object} data Graph configuration */ function HorizontalBarGraph(data) { this._data = data; diff --git a/app/assets/javascripts/graphs/width_scale.js b/app/assets/javascripts/graphs/width_scale.js index 891cfaf96..3ddd0decf 100644 --- a/app/assets/javascripts/graphs/width_scale.js +++ b/app/assets/javascripts/graphs/width_scale.js @@ -12,7 +12,7 @@ to the display size of the svg /** * Object for WidthScale - * @param {?} data Graph data + * @param {Object} data Graph configuration */ function WidthScale(data) { this._data = data;