Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix any jsdoc @class <name> to be @class, @alias <name> #825

Merged
merged 1 commit into from
May 29, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion src/canvas/canvasRenderer.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ var renderer = require('../renderer');
/**
* Create a new instance of class canvasRenderer.
*
* @class geo.canvas.renderer
* @class
* @alias geo.canvas.renderer
* @extends geo.renderer
* @param {object} arg Options for the renderer.
* @param {geo.layer} [arg.layer] Layer associated with the renderer.
Expand Down
3 changes: 2 additions & 1 deletion src/canvas/heatmapFeature.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ var timestamp = require('../timestamp');
* Inspired from
* https://github.com/mourner/simpleheat/blob/gh-pages/simpleheat.js
*
* @class geo.canvas.heatmapFeature
* @class
* @alias geo.canvas.heatmapFeature
* @param {Object} arg Options object
* @extends geo.heatmapFeature
* @returns {canvas_heatmapFeature}
Expand Down
3 changes: 2 additions & 1 deletion src/canvas/lineFeature.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ var lineFeature = require('../lineFeature');
/**
* Create a new instance of class lineFeature.
*
* @class geo.canvas.lineFeature
* @class
* @alias geo.canvas.lineFeature
* @extends geo.lineFeature
* @param {geo.lineFeature.spec} arg
* @returns {geo.canvas.lineFeature}
Expand Down
3 changes: 2 additions & 1 deletion src/canvas/pixelmapFeature.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ var pixelmapFeature = require('../pixelmapFeature');
/**
* Create a new instance of class pixelmapFeature
*
* @class geo.canvas.pixelmapFeature
* @class
* @alias geo.canvas.pixelmapFeature
* @param {Object} arg Options object
* @extends geo.pixelmapFeature
* @returns {canvas_pixelmapFeature}
Expand Down
3 changes: 2 additions & 1 deletion src/canvas/quadFeature.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ var util = require('../util');
/**
* Create a new instance of class quadFeature.
*
* @class geo.canvas.quadFeature
* @class
* @alias geo.canvas.quadFeature
* @param {geo.quadFeature.spec} arg Options object.
* @extends geo.quadFeature
* @returns {geo.canvas.quadFeature}
Expand Down
3 changes: 2 additions & 1 deletion src/choroplethFeature.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ var feature = require('./feature');
/**
* Create a new instance of class choroplethFeature
*
* @class geo.choroplethFeature
* @class
* @alias geo.choroplethFeature
* @param {Object} arg Options object
* @extends geo.feature
* @param {Array} [colorRange] Color lookup table for
Expand Down
3 changes: 2 additions & 1 deletion src/d3/d3Renderer.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ var renderer = require('../renderer');
/**
* Create a new instance of class d3Renderer.
*
* @class geo.d3.renderer
* @class
* @alias geo.d3.renderer
* @extends geo.renderer
* @param {object} arg Options for the renderer.
* @param {geo.layer} [arg.layer] Layer associated with the renderer.
Expand Down
3 changes: 2 additions & 1 deletion src/d3/graphFeature.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ var registerFeature = require('../registry').registerFeature;
var graphFeature = require('../graphFeature');

/**
* @class geo.d3.graphFeature
* @class
* @alias geo.d3.graphFeature
* @extends geo.graphFeature
*/
var d3_graphFeature = function (arg) {
Expand Down
3 changes: 2 additions & 1 deletion src/d3/lineFeature.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ var lineFeature = require('../lineFeature');
/**
* Create a new instance of class lineFeature.
*
* @class geo.d3.lineFeature
* @class
* @alias geo.d3.lineFeature
* @extends geo.lineFeature
* @param {geo.lineFeature.spec} arg
* @returns {geo.d3.lineFeature}
Expand Down
3 changes: 2 additions & 1 deletion src/d3/pathFeature.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ var pathFeature = require('../pathFeature');
/**
* Create a new instance of class pathFeature
*
* @class geo.d3.pathFeature
* @class
* @alias geo.d3.pathFeature
* @extends geo.pathFeature
* @extends geo.d3.object
* @returns {geo.d3.pathFeature}
Expand Down
3 changes: 2 additions & 1 deletion src/d3/pointFeature.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ var pointFeature = require('../pointFeature');
*
* Create a new instance of pointFeature
*
* @class geo.d3.pointFeature
* @class
* @alias geo.d3.pointFeature
* @extends geo.pointFeature
* @extends geo.d3.object
* @returns {geo.d3.pointFeature}
Expand Down
3 changes: 2 additions & 1 deletion src/d3/quadFeature.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ var quadFeature = require('../quadFeature');
/**
* Create a new instance of class quadFeature.
*
* @class geo.d3.quadFeature
* @class
* @alias geo.d3.quadFeature
* @param {geo.quadFeature.spec} arg Options object.
* @extends geo.quadFeature
* @returns {geo.d3.quadFeature}
Expand Down
3 changes: 2 additions & 1 deletion src/d3/vectorFeature.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ var vectorFeature = require('../vectorFeature');
/**
* Create a new instance of vectorFeature
*
* @class geo.d3.vectorFeature
* @class
* @alias geo.d3.vectorFeature
* @extends geo.vectorFeature
* @extends geo.d3.object
* @returns {geo.d3.vectorFeature}
Expand Down
3 changes: 2 additions & 1 deletion src/domRenderer.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ var registerRenderer = require('./registry').registerRenderer;
/**
* Create a new instance of class domRenderer.
*
* @class geo.domRenderer
* @class
* @alias geo.domRenderer
* @extends geo.renderer
* @param {object} arg Options for the renderer.
* @param {geo.layer} [arg.layer] Layer associated with the renderer.
Expand Down
3 changes: 2 additions & 1 deletion src/fileReader.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ var object = require('./object');
/**
* Create a new instance of class fileReader
*
* @class geo.fileReader
* @class
* @alias geo.fileReader
* @extends geo.object
* @returns {geo.fileReader}
*/
Expand Down
3 changes: 2 additions & 1 deletion src/gl/choroplethFeature.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ var choroplethFeature = require('../choroplethFeature');
/**
* Create a new instance of choroplethFeature
*
* @class geo.gl.choroplethFeature
* @class
* @alias geo.gl.choroplethFeature
* @extends geo.choroplethFeature
* @returns {geo.gl.choroplethFeature}
*/
Expand Down
3 changes: 2 additions & 1 deletion src/gl/contourFeature.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ var contourFeature = require('../contourFeature');
/**
* Create a new instance of contourFeature
*
* @class geo.gl.contourFeature
* @class
* @alias geo.gl.contourFeature
* @extends geo.contourFeature
* @returns {geo.gl.contourFeature}
*/
Expand Down
3 changes: 2 additions & 1 deletion src/gl/pointFeature.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ var pointFeature = require('../pointFeature');
/**
* Create a new instance of pointFeature
*
* @class geo.gl.pointFeature
* @class
* @alias geo.gl.pointFeature
* @extends geo.pointFeature
* @returns {geo.gl.pointFeature}
*/
Expand Down
3 changes: 2 additions & 1 deletion src/gl/quadFeature.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ var quadFeature = require('../quadFeature');
/**
* Create a new instance of class quadFeature.
*
* @class geo.gl.quadFeature
* @class
* @alias geo.gl.quadFeature
* @param {geo.quadFeature.spec} arg Options object.
* @extends geo.quadFeature
* @returns {geo.gl.quadFeature}
Expand Down
3 changes: 2 additions & 1 deletion src/gl/vglRenderer.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ var renderer = require('../renderer');
/**
* Create a new instance of class vglRenderer.
*
* @class geo.gl.vglRenderer
* @class
* @alias geo.gl.vglRenderer
* @extends geo.renderer
* @param {object} arg Options for the renderer.
* @param {geo.layer} [arg.layer] Layer associated with the renderer.
Expand Down
3 changes: 2 additions & 1 deletion src/graphFeature.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ var feature = require('./feature');
/**
* Create a new instance of class graphFeature
*
* @class geo.graphFeature
* @class
* @alias geo.graphFeature
* @extends geo.feature
* @returns {geo.graphFeature}
*/
Expand Down
3 changes: 2 additions & 1 deletion src/heatmapFeature.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ var transform = require('./transform');
/**
* Create a new instance of class heatmapFeature
*
* @class geo.heatmapFeature
* @class
* @alias geo.heatmapFeature
* @param {Object} arg Options object
* @extends geo.feature
* @param {Object|Function} [position] Position of the data. Default is
Expand Down
3 changes: 2 additions & 1 deletion src/pathFeature.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ var feature = require('./feature');
/**
* Create a new instance of class pathFeature
*
* @class geo.pathFeature
* @class
* @alias geo.pathFeature
* @extends geo.feature
* @returns {geo.pathFeature}
*/
Expand Down
3 changes: 2 additions & 1 deletion src/pixelmapFeature.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ var util = require('./util');
/**
* Create a new instance of class imagemapFeature
*
* @class geo.pixelmapFeature
* @class
* @alias geo.pixelmapFeature
* @param {Object} arg Options object
* @extends geo.feature
* @param {Object|Function|HTMLImageElement} [url] URL of a pixel map or an
Expand Down
3 changes: 2 additions & 1 deletion src/pointFeature.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ var feature = require('./feature');
/**
* Create a new instance of class pointFeature
*
* @class geo.pointFeature
* @class
* @alias geo.pointFeature
* @param {object} arg Options object
* @param {boolean} arg.clustering Enable point clustering
* @extends geo.feature
Expand Down
3 changes: 2 additions & 1 deletion src/quadFeature.js
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,8 @@ var feature = require('./feature');
/**
* Create a new instance of class quadFeature.
*
* @class geo.quadFeature
* @class
* @alias geo.quadFeature
* @param {geo.quadFeature.spec} arg Options object.
* @extends geo.feature
* @returns {geo.quadFeature}
Expand Down
3 changes: 2 additions & 1 deletion src/renderer.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ var object = require('./object');
/**
* Create a new instance of class renderer.
*
* @class geo.renderer
* @class
* @alias geo.renderer
* @extends geo.object
* @param {object} arg Options for the renderer.
* @param {geo.layer} [arg.layer] Layer associated with the renderer.
Expand Down
3 changes: 2 additions & 1 deletion src/timestamp.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ var inherit = require('./inherit');
/**
* Create a new instance of class timestamp.
*
* @class geo.timestamp
* @class
* @alias geo.timestamp
* @extends vgl.timestamp
* @returns {geo.timestamp}
*/
Expand Down
3 changes: 2 additions & 1 deletion src/transform.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ var util = require('./util');
* z values that are ignored in current mapping context, but will in the
* future perform more general 3D transformations.
*
* @class geo.transform
* @class
* @alias geo.transform
* @param {object} options Constructor options
* @param {string} options.source A proj4 string for the source projection
* @param {string} options.target A proj4 string for the target projection
Expand Down
3 changes: 2 additions & 1 deletion src/ui/legendWidget.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ var registerWidget = require('../registry').registerWidget;
/**
* Create a new instance of class legendWidget
*
* @class geo.gui.legendWidget
* @class
* @alias geo.gui.legendWidget
* @extends geo.gui.svgWidget
* @returns {geo.gui.legendWidget}
*/
Expand Down
3 changes: 2 additions & 1 deletion src/ui/sliderWidget.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ var registerWidget = require('../registry').registerWidget;
/**
* Create a new instance of class sliderWidget
*
* @class geo.gui.sliderWidget
* @class
* @alias geo.gui.sliderWidget
* @extends {geo.gui.svgWidget}
* @returns {geo.gui.sliderWidget}
*/
Expand Down
3 changes: 2 additions & 1 deletion src/vectorFeature.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ var feature = require('./feature');
/**
* Create a new instance of class vectorFeature
*
* @class geo.vectorFeature
* @class
* @alias geo.vectorFeature
* @extends geo.feature
* @returns {geo.vectorFeature}
*/
Expand Down