Browse Source

Adds missing @extends/@constructor to jsdoc (#3372)

* Adds missing @extends for constructors

* Adds names to constructors
revert-3409-performance
macleodbroad-wf 6 years ago
committed by Yotam Berkowitz
parent
commit
13747eedd3
15 changed files with 17 additions and 13 deletions
  1. +1
    -1
      lib/Queue.js
  2. +1
    -1
      lib/graph3d/DataGroup.js
  3. +1
    -1
      lib/shared/Activator.js
  4. +1
    -1
      lib/timeline/Core.js
  5. +1
    -1
      lib/timeline/Graph2d.js
  6. +1
    -0
      lib/timeline/Range.js
  7. +1
    -1
      lib/timeline/Timeline.js
  8. +1
    -0
      lib/timeline/component/BackgroundGroup.js
  9. +1
    -1
      lib/timeline/component/DataScale.js
  10. +1
    -1
      lib/timeline/component/GraphGroup.js
  11. +2
    -1
      lib/timeline/component/Legend.js
  12. +2
    -1
      lib/timeline/component/LineGraph.js
  13. +1
    -1
      lib/timeline/component/graph2d_types/bar.js
  14. +1
    -1
      lib/timeline/component/graph2d_types/line.js
  15. +1
    -1
      lib/timeline/component/graph2d_types/points.js

+ 1
- 1
lib/Queue.js View File

@ -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

+ 1
- 1
lib/graph3d/DataGroup.js View File

@ -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

+ 1
- 1
lib/shared/Activator.js View File

@ -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;

+ 1
- 1
lib/timeline/Core.js View File

@ -9,7 +9,7 @@ var CustomTime = require('./component/CustomTime');
/**
* Create a timeline visualization
* @constructor
* @constructor Core
*/
function Core () {}

+ 1
- 1
lib/timeline/Graph2d.js View File

@ -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) {

+ 1
- 0
lib/timeline/Range.js View File

@ -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);

+ 1
- 1
lib/timeline/Timeline.js View File

@ -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) {

+ 1
- 0
lib/timeline/component/BackgroundGroup.js View File

@ -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);

+ 1
- 1
lib/timeline/component/DataScale.js View File

@ -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];

+ 1
- 1
lib/timeline/component/GraphGroup.js View File

@ -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;

+ 2
- 1
lib/timeline/component/Legend.js View File

@ -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;

+ 2
- 1
lib/timeline/component/LineGraph.js View File

@ -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();

+ 1
- 1
lib/timeline/component/graph2d_types/bar.js View File

@ -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
}

+ 1
- 1
lib/timeline/component/graph2d_types/line.js View File

@ -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
}

+ 1
- 1
lib/timeline/component/graph2d_types/points.js View File

@ -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
}

Loading…
Cancel
Save