Merge pull request #825 from OpenGeoscience/fix-class-alias-docs

Fix any jsdoc @Class <name> to be @Class, @alias <name>

src/canvas/canvasRenderer.js

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

src/canvas/heatmapFeature.js

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

src/canvas/lineFeature.js

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

src/canvas/pixelmapFeature.js

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

src/canvas/quadFeature.js

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

src/choroplethFeature.js

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

src/d3/d3Renderer.js

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

src/d3/graphFeature.js

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

src/d3/lineFeature.js

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

src/d3/pathFeature.js

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

src/d3/pointFeature.js

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

src/d3/quadFeature.js

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

src/d3/vectorFeature.js

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

src/domRenderer.js

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

src/fileReader.js

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

src/gl/choroplethFeature.js

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

src/gl/contourFeature.js

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

src/gl/pointFeature.js

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

src/gl/quadFeature.js

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

src/gl/vglRenderer.js

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

src/graphFeature.js

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

src/heatmapFeature.js

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

src/pathFeature.js

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

src/pixelmapFeature.js

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

src/pointFeature.js

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

src/quadFeature.js

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

src/renderer.js

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

src/timestamp.js

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

src/transform.js

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

src/ui/legendWidget.js

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

src/ui/sliderWidget.js

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

src/vectorFeature.js

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