Enables "ClassDeclaration" for require-jsdoc lint rule, and adds all missing class-level jsdoc (#3373)

.eslintrc

@@ -23,7 +23,7 @@
         "require": {
             "FunctionDeclaration": true,
             "MethodDefinition": false,
-            "ClassDeclaration": false,
+            "ClassDeclaration": true,
             "ArrowFunctionExpression": false
         }
     }],

lib/network/NetworkUtil.js

@@ -1,4 +1,8 @@
 let util = require("../util");
+
+/**
+ * @constructor NetworkUtil
+ */
 class NetworkUtil {
   constructor() {}
 

lib/network/modules/CanvasRenderer.js

@@ -43,7 +43,12 @@ function _initRequestAnimationFrame() {
 
 let util = require('../../util');
 
-
+/**
+ *
+ * @param {Object} body
+ * @param {Canvas} canvas
+ * @constructor CanvasRenderer
+ */
 class CanvasRenderer {
   constructor(body, canvas) {
     _initRequestAnimationFrame();

lib/network/modules/Clustering.js

@@ -98,6 +98,11 @@ var Cluster = require('./components/nodes/Cluster').default;
 var Edge = require('./components/Edge').default;  // Only needed for check on type!
 var Node = require('./components/Node').default;  // Only needed for check on type!
 
+/**
+ *
+ * @param {Object} body
+ * @constructor ClusterEngine
+ */
 class ClusterEngine {
   constructor(body) {
     this.body = body;

lib/network/modules/EdgesHandler.js

@@ -5,6 +5,13 @@ var DataView = require('../../DataView');
 var Edge = require("./components/Edge").default;
 var Label = require("./components/shared/Label").default;
 
+/**
+ *
+ * @param {Object} body
+ * @param {Array<Image>} images
+ * @param {Array<Group>} groups
+ * @constructor EdgesHandler
+ */
 class EdgesHandler {
   constructor(body, images, groups) {
     this.body = body;

lib/network/modules/InteractionHandler.js

@@ -3,6 +3,13 @@ let util = require('../../util');
 var NavigationHandler = require('./components/NavigationHandler').default;
 var Popup = require('./../../shared/Popup').default;
 
+/**
+ *
+ * @param {Object} body
+ * @param {Canvas} canvas
+ * @param {SelectionHandler} selectionHandler
+ * @constructor InteractionHandler
+ */
 class InteractionHandler {
   constructor(body, canvas, selectionHandler) {
     this.body = body;

lib/network/modules/LayoutEngine.js

@@ -308,7 +308,11 @@ class HierarchicalStatus {
   }
 }
 
-
+/**
+ *
+ * @param {Object} body
+ * @constructor LayoutEngine
+ */
 class LayoutEngine {
   constructor(body) {
     this.body = body;

lib/network/modules/NodesHandler.js

@@ -5,6 +5,14 @@ let DataView = require('../../DataView');
 var Node = require("./components/Node").default;
 var Label = require("./components/shared/Label").default;
 
+/**
+ *
+ * @param {Object} body
+ * @param {Array<Image>} images
+ * @param {Array<Group>} groups
+ * @param {LayoutEngine} layoutEngine
+ * @constructor NodesHandler
+ */
 class NodesHandler {
   constructor(body, images, groups, layoutEngine) {
     this.body = body;

lib/network/modules/PhysicsEngine.js

@@ -10,6 +10,11 @@ var ForceAtlas2BasedCentralGravitySolver = require('./components/physics/FA2Base
 var util = require('../../util');
 
 
+/**
+ *
+ * @param {Object} body
+ * @constructor PhysicsEngine
+ */
 class PhysicsEngine {
   constructor(body) {
     this.body = body;

lib/network/modules/SelectionHandler.js

@@ -3,6 +3,12 @@ var Edge = require('./components/Edge').default;
 
 let util = require('../../util');
 
+/**
+ *
+ * @param {Object} body
+ * @param {Canvas} canvas
+ * @constructor SelectionHandler
+ */
 class SelectionHandler {
   constructor(body, canvas) {
     this.body = body;

lib/network/modules/View.js

@@ -2,6 +2,12 @@ let util = require('../../util');
 
 var NetworkUtil = require('../NetworkUtil').default;
 
+/**
+ *
+ * @param {Object} body
+ * @param {Canvas} canvas
+ * @constructor View
+ */
 class View {
   constructor(body, canvas) {
     this.body = body;

lib/network/modules/components/NavigationHandler.js

@@ -2,6 +2,12 @@ var Hammer = require('../../../module/hammer');
 var hammerUtil = require('../../../hammerUtil');
 var keycharm = require('keycharm');
 
+/**
+ *
+ * @param {Object} body
+ * @param {Canvas} canvas
+ * @constructor NavigationHandler
+ */
 class NavigationHandler {
   constructor(body, canvas) {
     this.body = body;

lib/network/modules/components/algorithms/FloydWarshall.js

@@ -1,8 +1,6 @@
 /**
- * Created by Alex on 10-Aug-15.
+ * @constructor FloydWarshall
  */
-
-
 class FloydWarshall {
   constructor() {
   }

lib/network/modules/components/edges/BezierEdgeDynamic.js

@@ -1,5 +1,16 @@
 import BezierEdgeBase from './util/BezierEdgeBase'
 
+/**
+ * A Dynamic Bezier Edge. Bezier curves are used to model smooth gradual
+ * curves in paths between nodes. The Dynamic piece refers to how the curve
+ * reacts to physics changes.
+ *
+ * @param {Object} options
+ * @param {Object} body
+ * @param {Label} labelModule
+ * @constructor BezierEdgeDynamic
+ * @extends BezierEdgeBase
+ */
 class BezierEdgeDynamic extends BezierEdgeBase {
   constructor(options, body, labelModule) {
     //this.via = undefined; // Here for completeness but not allowed to defined before super() is invoked.
@@ -27,7 +38,7 @@ class BezierEdgeDynamic extends BezierEdgeBase {
 
     // when we change the physics state of the edge, we reposition the support node.
     if (physicsChange === true) {
-      this.via.setOptions({physics: this.options.physics})
+      this.via.setOptions({physics: this.options.physics});
       this.positionBezierNode();
     }
   }

lib/network/modules/components/edges/BezierEdgeStatic.js

@@ -1,5 +1,15 @@
 import BezierEdgeBase from './util/BezierEdgeBase'
 
+/**
+ * A Static Bezier Edge. Bezier curves are used to model smooth gradual
+ * curves in paths between nodes.
+ *
+ * @param {Object} options
+ * @param {Object} body
+ * @param {Label} labelModule
+ * @constructor BezierEdgeStatic
+ * @extends BezierEdgeBase
+ */
 class BezierEdgeStatic extends BezierEdgeBase {
   constructor(options, body, labelModule) {
     super(options, body, labelModule);

lib/network/modules/components/edges/CubicBezierEdge.js

@@ -1,5 +1,15 @@
 import CubicBezierEdgeBase from './util/CubicBezierEdgeBase'
 
+/**
+ * A Cubic Bezier Edge. Bezier curves are used to model smooth gradual
+ * curves in paths between nodes.
+ *
+ * @param {Object} options
+ * @param {Object} body
+ * @param {Label} labelModule
+ * @constructor CubicBezierEdge
+ * @extends CubicBezierEdgeBase
+ */
 class CubicBezierEdge extends CubicBezierEdgeBase {
   constructor(options, body, labelModule) {
     super(options, body, labelModule);

lib/network/modules/components/edges/StraightEdge.js

@@ -1,5 +1,14 @@
 import EdgeBase from './util/EdgeBase'
 
+/**
+ * A Straight Edge.
+ *
+ * @param {Object} options
+ * @param {Object} body
+ * @param {Label} labelModule
+ * @constructor StraightEdge
+ * @extends EdgeBase
+ */
 class StraightEdge extends EdgeBase {
   constructor(options, body, labelModule) {
     super(options, body, labelModule);

lib/network/modules/components/edges/util/BezierEdgeBase.js

@@ -1,5 +1,15 @@
 import EdgeBase from './EdgeBase'
 
+/**
+ * The Base Class for all Bezier edges. Bezier curves are used to model smooth
+ * gradual curves in paths between nodes.
+ *
+ * @param {Object} options
+ * @param {Object} body
+ * @param {Label} labelModule
+ * @constructor BezierEdgeBase
+ * @extends EdgeBase
+ */
 class BezierEdgeBase extends EdgeBase {
   constructor(options, body, labelModule) {
     super(options, body, labelModule);

lib/network/modules/components/edges/util/CubicBezierEdgeBase.js

@@ -1,5 +1,15 @@
 import BezierEdgeBase from './BezierEdgeBase'
 
+/**
+ * A Base Class for all Cubic Bezier Edges. Bezier curves are used to model
+ * smooth gradual curves in paths between nodes.
+ *
+ * @param {Object} options
+ * @param {Object} body
+ * @param {Label} labelModule
+ * @constructor CubicBezierEdgeBase
+ * @extends BezierEdgeBase
+ */
 class CubicBezierEdgeBase extends BezierEdgeBase {
   constructor(options, body, labelModule) {
     super(options, body, labelModule);

lib/network/modules/components/edges/util/EdgeBase.js

@@ -1,5 +1,13 @@
 let util = require("../../../../../util");
 
+/**
+ * The Base Class for all edges.
+ *
+ * @param {Object} options
+ * @param {Object} body
+ * @param {Label} labelModule
+ * @constructor EdgeBase
+ */
 class EdgeBase {
   constructor(options, body, labelModule) {
     this.body = body;

lib/network/modules/components/nodes/Cluster.js

@@ -1,7 +1,16 @@
 import Node from '../Node'
 
 /**
+ * A Cluster is a special Node that allows a group of Nodes positioned closely together
+ * to be represented by a single Cluster Node.
  *
+ * @param {Object} options
+ * @param {Object} body
+ * @param {Array<HTMLImageElement>}imagelist
+ * @param {Array} grouplist
+ * @param {Object} globalOptions
+ * @constructor Cluster
+ * @extends Node
  */
 class Cluster extends Node {
   constructor(options, body, imagelist, grouplist, globalOptions) {

lib/network/modules/components/nodes/shapes/Box.js

@@ -2,6 +2,15 @@
 
 import NodeBase from '../util/NodeBase'
 
+/**
+ * A Box Node/Cluster shape.
+ *
+ * @param {Object} options
+ * @param {Object} body
+ * @param {Label} labelModule
+ * @constructor Box
+ * @extends NodeBase
+ */
 class Box extends NodeBase {
   constructor (options, body, labelModule) {
     super(options,body,labelModule);

lib/network/modules/components/nodes/shapes/Circle.js

@@ -2,6 +2,15 @@
 
 import CircleImageBase from '../util/CircleImageBase'
 
+/**
+ * A Circle Node/Cluster shape.
+ *
+ * @param {Object} options
+ * @param {Object} body
+ * @param {Label} labelModule
+ * @constructor Circle
+ * @extends CircleImageBase
+ */
 class Circle extends CircleImageBase {
   constructor(options, body, labelModule) {
     super(options, body, labelModule);

lib/network/modules/components/nodes/shapes/CircularImage.js

@@ -2,6 +2,15 @@
 
 import CircleImageBase from '../util/CircleImageBase'
 
+/**
+ * A CircularImage Node/Cluster shape.
+ *
+ * @param {Object} options
+ * @param {Object} body
+ * @param {Label} labelModule
+ * @constructor CircularImage
+ * @extends CircleImageBase
+ */
 class CircularImage extends CircleImageBase {
   constructor (options, body, labelModule, imageObj, imageObjAlt) {
     super(options, body, labelModule);

lib/network/modules/components/nodes/shapes/Database.js

@@ -2,6 +2,15 @@
 
 import NodeBase from '../util/NodeBase'
 
+/**
+ * A Database Node/Cluster shape.
+ *
+ * @param {Object} options
+ * @param {Object} body
+ * @param {Label} labelModule
+ * @constructor Database
+ * @extends NodeBase
+ */
 class Database extends NodeBase {
   constructor (options, body, labelModule) {
     super(options, body, labelModule);

lib/network/modules/components/nodes/shapes/Diamond.js

@@ -2,6 +2,15 @@
 
 import ShapeBase from '../util/ShapeBase'
 
+/**
+ * A Diamond Node/Cluster shape.
+ *
+ * @param {Object} options
+ * @param {Object} body
+ * @param {Label} labelModule
+ * @constructor Diamond
+ * @extends ShapeBase
+ */
 class Diamond extends ShapeBase {
   constructor(options, body, labelModule) {
     super(options, body, labelModule)

lib/network/modules/components/nodes/shapes/Dot.js

@@ -2,6 +2,15 @@
 
 import ShapeBase from '../util/ShapeBase'
 
+/**
+ * A Dot Node/Cluster shape.
+ *
+ * @param {Object} options
+ * @param {Object} body
+ * @param {Label} labelModule
+ * @constructor Dot
+ * @extends ShapeBase
+ */
 class Dot extends ShapeBase {
   constructor(options, body, labelModule) {
     super(options, body, labelModule)

lib/network/modules/components/nodes/shapes/Ellipse.js

@@ -2,6 +2,15 @@
 
 import NodeBase from '../util/NodeBase'
 
+/**
+ * Am Ellipse Node/Cluster shape.
+ *
+ * @param {Object} options
+ * @param {Object} body
+ * @param {Label} labelModule
+ * @constructor Ellipse
+ * @extends NodeBase
+ */
 class Ellipse extends NodeBase {
   constructor(options, body, labelModule) {
     super(options, body, labelModule);

lib/network/modules/components/nodes/shapes/Icon.js

@@ -2,6 +2,15 @@
 
 import NodeBase from '../util/NodeBase'
 
+/**
+ * An icon replacement for the default Node shape.
+ *
+ * @param {Object} options
+ * @param {Object} body
+ * @param {Label} labelModule
+ * @constructor Icon
+ * @extends NodeBase
+ */
 class Icon extends NodeBase {
   constructor(options, body, labelModule) {
     super(options, body, labelModule);

lib/network/modules/components/nodes/shapes/Image.js

@@ -2,6 +2,16 @@
 
 import CircleImageBase from '../util/CircleImageBase'
 
+
+/**
+ * An image-based replacement for the default Node shape.
+ *
+ * @param {Object} options
+ * @param {Object} body
+ * @param {Label} labelModule
+ * @constructor Image
+ * @extends CircleImageBase
+ */
 class Image extends CircleImageBase {
   constructor (options, body, labelModule, imageObj, imageObjAlt) {
     super(options, body, labelModule);

lib/network/modules/components/nodes/shapes/Square.js

@@ -2,6 +2,15 @@
 
 import ShapeBase from '../util/ShapeBase'
 
+/**
+ * A Square Node/Cluster shape.
+ *
+ * @param {Object} options
+ * @param {Object} body
+ * @param {Label} labelModule
+ * @constructor Square
+ * @extends ShapeBase
+ */
 class Square extends ShapeBase {
   constructor(options, body, labelModule) {
     super(options, body, labelModule)

lib/network/modules/components/nodes/shapes/Star.js

@@ -2,6 +2,15 @@
 
 import ShapeBase from '../util/ShapeBase'
 
+/**
+ * A Star Node/Cluster shape.
+ *
+ * @param {Object} options
+ * @param {Object} body
+ * @param {Label} labelModule
+ * @constructor TriangleDown
+ * @extends ShapeBase
+ */
 class Star extends ShapeBase {
   constructor(options, body, labelModule) {
     super(options, body, labelModule)

lib/network/modules/components/nodes/shapes/Text.js

@@ -2,6 +2,15 @@
 
 import NodeBase from '../util/NodeBase'
 
+/**
+ * A text-based replacement for the default Node shape.
+ *
+ * @param {Object} options
+ * @param {Object} body
+ * @param {Label} labelModule
+ * @constructor Text
+ * @extends NodeBase
+ */
 class Text extends NodeBase {
   constructor(options, body, labelModule) {
     super(options, body, labelModule);

lib/network/modules/components/nodes/shapes/Triangle.js

@@ -2,6 +2,15 @@
 
 import ShapeBase from '../util/ShapeBase'
 
+/**
+ * A Triangle Node/Cluster shape.
+ *
+ * @param {Object} options
+ * @param {Object} body
+ * @param {Label} labelModule
+ * @constructor Triangle
+ * @extends ShapeBase
+ */
 class Triangle extends ShapeBase {
   constructor(options, body, labelModule) {
     super(options, body, labelModule)

lib/network/modules/components/nodes/shapes/TriangleDown.js

@@ -2,6 +2,15 @@
 
 import ShapeBase from '../util/ShapeBase'
 
+/**
+ * A downward facing Triangle Node/Cluster shape.
+ *
+ * @param {Object} options
+ * @param {Object} body
+ * @param {Label} labelModule
+ * @constructor TriangleDown
+ * @extends ShapeBase
+ */
 class TriangleDown extends ShapeBase {
   constructor(options, body, labelModule) {
     super(options, body, labelModule)

lib/network/modules/components/nodes/util/NodeBase.js

@@ -1,3 +1,11 @@
+/**
+ * The Base class for all Nodes.
+ *
+ * @param {Object} options
+ * @param {Object} body
+ * @param {Label} labelModule
+ * @constructor NodeBase
+ */
 class NodeBase {
   constructor(options, body, labelModule) {
     this.body = body;

lib/network/modules/components/nodes/util/ShapeBase.js

@@ -1,5 +1,14 @@
 import NodeBase from '../util/NodeBase'
 
+/**
+ * Base class for constructing Node/Cluster Shapes.
+ *
+ * @param {Object} options
+ * @param {Object} body
+ * @param {Label} labelModule
+ * @constructor ShapeBase
+ * @extends NodeBase
+ */
 class ShapeBase extends NodeBase {
   constructor(options, body, labelModule) {
     super(options, body, labelModule)

lib/network/modules/components/physics/BarnesHutSolver.js

@@ -1,3 +1,10 @@
+/**
+ *
+ * @param {Object} body
+ * @param {{physicsNodeIndices: Array, physicsEdgeIndices: Array, forces: {}, velocities: {}}} physicsBody
+ * @param {Object} options
+ * @constructor BarnesHutSolver
+ */
 class BarnesHutSolver {
   constructor(body, physicsBody, options) {
     this.body = body;

lib/network/modules/components/physics/CentralGravitySolver.js

@@ -1,3 +1,10 @@
+/**
+ *
+ * @param {Object} body
+ * @param {{physicsNodeIndices: Array, physicsEdgeIndices: Array, forces: {}, velocities: {}}} physicsBody
+ * @param {Object} options
+ * @constructor CentralGravitySolver
+ */
 class CentralGravitySolver {
   constructor(body, physicsBody, options) {
     this.body = body;

lib/network/modules/components/physics/FA2BasedCentralGravitySolver.js

@@ -1,5 +1,13 @@
 import CentralGravitySolver from "./CentralGravitySolver"
 
+/**
+ *
+ * @param {Object} body
+ * @param {{physicsNodeIndices: Array, physicsEdgeIndices: Array, forces: {}, velocities: {}}} physicsBody
+ * @param {Object} options
+ * @constructor ForceAtlas2BasedCentralGravitySolver
+ * @extends CentralGravitySolver
+ */
 class ForceAtlas2BasedCentralGravitySolver extends CentralGravitySolver {
   constructor(body, physicsBody, options) {
     super(body, physicsBody, options);

lib/network/modules/components/physics/FA2BasedRepulsionSolver.js

@@ -1,5 +1,13 @@
 import BarnesHutSolver from "./BarnesHutSolver"
 
+/**
+ *
+ * @param {Object} body
+ * @param {{physicsNodeIndices: Array, physicsEdgeIndices: Array, forces: {}, velocities: {}}} physicsBody
+ * @param {Object} options
+ * @constructor ForceAtlas2BasedRepulsionSolver
+ * @extends BarnesHutSolver
+ */
 class ForceAtlas2BasedRepulsionSolver extends BarnesHutSolver {
   constructor(body, physicsBody, options) {
     super(body, physicsBody, options);

lib/network/modules/components/physics/HierarchicalRepulsionSolver.js

@@ -1,3 +1,10 @@
+/**
+ *
+ * @param {Object} body
+ * @param {{physicsNodeIndices: Array, physicsEdgeIndices: Array, forces: {}, velocities: {}}} physicsBody
+ * @param {Object} options
+ * @constructor HierarchicalRepulsionSolver
+ */
 class HierarchicalRepulsionSolver {
   constructor(body, physicsBody, options) {
     this.body = body;

lib/network/modules/components/physics/HierarchicalSpringSolver.js

@@ -1,3 +1,10 @@
+/**
+ *
+ * @param {Object} body
+ * @param {{physicsNodeIndices: Array, physicsEdgeIndices: Array, forces: {}, velocities: {}}} physicsBody
+ * @param {Object} options
+ * @constructor HierarchicalSpringSolver
+ */
 class HierarchicalSpringSolver {
   constructor(body, physicsBody, options) {
     this.body = body;

lib/network/modules/components/physics/RepulsionSolver.js

@@ -1,3 +1,10 @@
+/**
+ *
+ * @param {Object} body
+ * @param {{physicsNodeIndices: Array, physicsEdgeIndices: Array, forces: {}, velocities: {}}} physicsBody
+ * @param {Object} options
+ * @constructor RepulsionSolver
+ */
 class RepulsionSolver {
   constructor(body, physicsBody, options) {
     this.body = body;

lib/network/modules/components/physics/SpringSolver.js

@@ -1,3 +1,10 @@
+/**
+ *
+ * @param {Object} body
+ * @param {{physicsNodeIndices: Array, physicsEdgeIndices: Array, forces: {}, velocities: {}}} physicsBody
+ * @param {Object} options
+ * @constructor SpringSolver
+ */
 class SpringSolver {
   constructor(body, physicsBody, options) {
     this.body = body;

lib/network/modules/components/shared/Label.js

@@ -134,7 +134,14 @@ class LabelAccumulator {
   }
 } 
 
-
+/**
+ * A Label to be used for Nodes or Edges.
+ *
+ * @param {Object} options
+ * @param {Object} body
+ * @param {boolean} [edgeLabel=false]
+ * @constructor Label
+ */
 class Label {
   constructor(body, options, edgelabel = false) {
     this.body = body;

lib/shared/ColorPicker.js

@@ -2,6 +2,10 @@ let Hammer = require('../module/hammer');
 let hammerUtil = require('../hammerUtil');
 let util = require('../util');
 
+/**
+ *
+ * @param {Number} [pixelRatio=1]
+ */
 class ColorPicker {
   constructor(pixelRatio = 1) {
     this.pixelRatio = pixelRatio;