From 13747eedd3931b360f80865befe85fb360499833 Mon Sep 17 00:00:00 2001 From: macleodbroad-wf Date: Sat, 19 Aug 2017 10:31:13 -0400 Subject: [PATCH] Adds missing @extends/@constructor to jsdoc (#3372) * Adds missing @extends for constructors * Adds names to constructors --- lib/Queue.js | 2 +- lib/graph3d/DataGroup.js | 2 +- lib/shared/Activator.js | 2 +- lib/timeline/Core.js | 2 +- lib/timeline/Graph2d.js | 2 +- lib/timeline/Range.js | 1 + lib/timeline/Timeline.js | 2 +- lib/timeline/component/BackgroundGroup.js | 1 + lib/timeline/component/DataScale.js | 2 +- lib/timeline/component/GraphGroup.js | 2 +- lib/timeline/component/Legend.js | 3 ++- lib/timeline/component/LineGraph.js | 3 ++- lib/timeline/component/graph2d_types/bar.js | 2 +- lib/timeline/component/graph2d_types/line.js | 2 +- lib/timeline/component/graph2d_types/points.js | 2 +- 15 files changed, 17 insertions(+), 13 deletions(-) diff --git a/lib/Queue.js b/lib/Queue.js index 843a234b..9ad5eaf6 100644 --- a/lib/Queue.js +++ b/lib/Queue.js @@ -9,7 +9,7 @@ * - max: number When the queue exceeds the given maximum number * of entries, the queue is flushed automatically. * Default value of max is Infinity. - * @constructor + * @constructor Queue */ function Queue(options) { // options diff --git a/lib/graph3d/DataGroup.js b/lib/graph3d/DataGroup.js index 3257ad76..512974cb 100644 --- a/lib/graph3d/DataGroup.js +++ b/lib/graph3d/DataGroup.js @@ -16,7 +16,7 @@ var Point3d = require('./Point3d'); * * Error: Array, DataSet, or DataView expected * - * @constructor + * @constructor DataGroup */ function DataGroup() { this.dataTable = null; // The original data table diff --git a/lib/shared/Activator.js b/lib/shared/Activator.js index 62b8754d..5b739cba 100644 --- a/lib/shared/Activator.js +++ b/lib/shared/Activator.js @@ -11,7 +11,7 @@ var util = require('../util'); * the interactive contents of the element can be used. When clicked outside * the element, the elements mode is changed to inactive. * @param {Element} container - * @constructor + * @constructor Activator */ function Activator(container) { this.active = false; diff --git a/lib/timeline/Core.js b/lib/timeline/Core.js index d54c2e5f..5213190e 100644 --- a/lib/timeline/Core.js +++ b/lib/timeline/Core.js @@ -9,7 +9,7 @@ var CustomTime = require('./component/CustomTime'); /** * Create a timeline visualization - * @constructor + * @constructor Core */ function Core () {} diff --git a/lib/timeline/Graph2d.js b/lib/timeline/Graph2d.js index d7908b76..198f86a7 100644 --- a/lib/timeline/Graph2d.js +++ b/lib/timeline/Graph2d.js @@ -22,7 +22,7 @@ var Validator = require('../shared/Validator').default; * @param {vis.DataSet | Array} [items] * @param {vis.DataSet | Array | vis.DataView | Object} [groups] * @param {Object} [options] See Graph2d.setOptions for the available options. - * @constructor + * @constructor Graph2d * @extends Core */ function Graph2d (container, items, groups, options) { diff --git a/lib/timeline/Range.js b/lib/timeline/Range.js index 550a3798..fba9fe03 100644 --- a/lib/timeline/Range.js +++ b/lib/timeline/Range.js @@ -10,6 +10,7 @@ var DateUtil = require('./DateUtil'); * @param {{dom: Object, domProps: Object, emitter: Emitter}} body * @param {Object} [options] See description at Range.setOptions * @constructor Range + * @extends Component */ function Range(body, options) { var now = moment().hours(0).minutes(0).seconds(0).milliseconds(0); diff --git a/lib/timeline/Timeline.js b/lib/timeline/Timeline.js index c731deb6..326b7f89 100644 --- a/lib/timeline/Timeline.js +++ b/lib/timeline/Timeline.js @@ -23,7 +23,7 @@ var Validator = require('../shared/Validator').default; * @param {vis.DataSet | vis.DataView | Array} [items] * @param {vis.DataSet | vis.DataView | Array} [groups] * @param {Object} [options] See Timeline.setOptions for the available options. - * @constructor + * @constructor Timeline * @extends Core */ function Timeline (container, items, groups, options) { diff --git a/lib/timeline/component/BackgroundGroup.js b/lib/timeline/component/BackgroundGroup.js index 3ce5ecff..f83eadaf 100644 --- a/lib/timeline/component/BackgroundGroup.js +++ b/lib/timeline/component/BackgroundGroup.js @@ -5,6 +5,7 @@ var Group = require('./Group'); * @param {Number | String} groupId * @param {Object} data * @param {ItemSet} itemSet + * @extends Group */ function BackgroundGroup (groupId, data, itemSet) { Group.call(this, groupId, data, itemSet); diff --git a/lib/timeline/component/DataScale.js b/lib/timeline/component/DataScale.js index abb062a5..a9cf26a4 100644 --- a/lib/timeline/component/DataScale.js +++ b/lib/timeline/component/DataScale.js @@ -8,7 +8,7 @@ * @param {number} majorCharHeight * @param {boolean} zeroAlign * @param {function} formattingFunction - * @constructor + * @constructor DataScale */ function DataScale(start, end, autoScaleStart, autoScaleEnd, containerHeight, majorCharHeight, zeroAlign = false, formattingFunction=false) { this.majorSteps = [1, 2, 5, 10]; diff --git a/lib/timeline/component/GraphGroup.js b/lib/timeline/component/GraphGroup.js index 6b5eab27..388e63f8 100644 --- a/lib/timeline/component/GraphGroup.js +++ b/lib/timeline/component/GraphGroup.js @@ -11,7 +11,7 @@ var Points = require('./graph2d_types/points'); * @param {array} groupsUsingDefaultStyles | this array has one entree. * It is passed as an array so it is passed by reference. * It enumerates through the default styles - * @constructor + * @constructor GraphGroup */ function GraphGroup(group, groupId, options, groupsUsingDefaultStyles) { this.id = groupId; diff --git a/lib/timeline/component/Legend.js b/lib/timeline/component/Legend.js index 578e2e76..da99bc30 100644 --- a/lib/timeline/component/Legend.js +++ b/lib/timeline/component/Legend.js @@ -9,7 +9,8 @@ var Component = require('./Component'); * @param {vis.Graph2d.options} options * @param {number} side * @param {vis.LineGraph.options} linegraphOptions - * @constructor + * @constructor Legend + * @extends Component */ function Legend(body, options, side, linegraphOptions) { this.body = body; diff --git a/lib/timeline/component/LineGraph.js b/lib/timeline/component/LineGraph.js index dc3980bb..10704997 100644 --- a/lib/timeline/component/LineGraph.js +++ b/lib/timeline/component/LineGraph.js @@ -17,7 +17,8 @@ var UNGROUPED = '__ungrouped__'; // reserved group id for ungrouped items * * @param {vis.Timeline.body} body * @param {Object} options - * @constructor + * @constructor LineGraph + * @extends Component */ function LineGraph(body, options) { this.id = util.randomUUID(); diff --git a/lib/timeline/component/graph2d_types/bar.js b/lib/timeline/component/graph2d_types/bar.js index 2cefb5b7..086bf1dc 100644 --- a/lib/timeline/component/graph2d_types/bar.js +++ b/lib/timeline/component/graph2d_types/bar.js @@ -5,7 +5,7 @@ var Points = require('./points'); * * @param {vis.GraphGroup.id} groupId * @param {Object} options // TODO: Describe options - * @constructor + * @constructor Bargraph */ function Bargraph(groupId, options) { // eslint-disable-line no-unused-vars } diff --git a/lib/timeline/component/graph2d_types/line.js b/lib/timeline/component/graph2d_types/line.js index d6155054..ba5c10be 100644 --- a/lib/timeline/component/graph2d_types/line.js +++ b/lib/timeline/component/graph2d_types/line.js @@ -4,7 +4,7 @@ var DOMutil = require('../../../DOMutil'); * * @param {vis.GraphGroup.id} groupId * @param {Object} options // TODO: Describe options - * @constructor + * @constructor Line */ function Line(groupId, options) { // eslint-disable-line no-unused-vars } diff --git a/lib/timeline/component/graph2d_types/points.js b/lib/timeline/component/graph2d_types/points.js index 73cb4389..4cf17e43 100644 --- a/lib/timeline/component/graph2d_types/points.js +++ b/lib/timeline/component/graph2d_types/points.js @@ -5,7 +5,7 @@ var DOMutil = require('../../../DOMutil'); * @param {Number | String} groupId * @param {Object} options // TODO: Describe options * - * @constructor + * @constructor Points */ function Points(groupId, options) { // eslint-disable-line no-unused-vars }