Skip to content

Commit

Permalink
Fix some of the jsdocs.
Browse files Browse the repository at this point in the history
I've added a config file for jsdoc so that the class names show the long name.  This makes it so instead of seeing four quadFeature in the table of contents, you now see geo.quadFeature, geo.gl.quadFeature, geo.canvas.quadFeature, and geo.d3.quadFeature.

I fixed a few other minor jsdoc issues.

I also added a build-examples script to package.json.
  • Loading branch information
manthey committed Jun 1, 2016
1 parent 66707ce commit 82e023d
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 5 deletions.
7 changes: 7 additions & 0 deletions jsdoc.conf.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"templates": {
"default": {
"useLongnameInNav": true
}
}
}
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@
},
"scripts": {
"build": "webpack --config webpack.config.js && webpack --config external.config.js",
"build-examples": "webpack --config webpack-examples.config.js",
"lint": "eslint --cache .",
"test": "karma start karma-cov.conf.js --single-run",
"start": "karma start karma.conf.js",
Expand All @@ -78,7 +79,7 @@
"examples": "webpack-dev-server --config webpack-examples.config.js --port 8082 --content-base dist/",
"start-test": "node examples/build.js; forever start ./testing/test-runners/server.js",
"stop-test": "forever stop ./testing/test-runners/server.js",
"docs": "jsdoc --pedantic -d dist/apidocs -r src"
"docs": "jsdoc --pedantic -d dist/apidocs -r src -c jsdoc.conf.json"
},
"keywords": [
"map",
Expand Down
2 changes: 1 addition & 1 deletion src/heatmapFeature.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ var transform = require('./transform');
/**
* Create a new instance of class heatmapFeature
*
* @class
* @class geo.heatmapFeature
* @param {Object} arg Options object
* @extends geo.feature
* @param {Object|Function} [position] Position of the data. Default is
Expand Down
12 changes: 10 additions & 2 deletions src/quadFeature.js
Original file line number Diff line number Diff line change
Expand Up @@ -129,8 +129,12 @@ var quadFeature = function (arg) {
/**
* Point search method for selection api. Returns markers containing the
* given point.
* @argument {Object} coordinate
* @returns {Object}
*
* @memberof geo.quadFeature
* @param {Object} coordinate coordinate in input gcs to check if it is
* located in any quad.
* @returns {Object} an object with 'index': a list of quad indices, and
* 'found': a list of quads that contain the specified coordinate.
*/
////////////////////////////////////////////////////////////////////////////
this.pointSearch = function (coordinate) {
Expand Down Expand Up @@ -170,6 +174,9 @@ var quadFeature = function (arg) {
/**
* Get/Set position
*
* @memberof geo.quadFeature
* @param {object|function} [position] object or function that returns the
* position of each quad.
* @returns {geo.quadFeature}
*/
////////////////////////////////////////////////////////////////////////////
Expand Down Expand Up @@ -444,6 +451,7 @@ var quadFeature = function (arg) {

/**
* Create a quadFeature from an object.
*
* @see {@link geo.feature.create}
* @param {geo.layer} layer The layer to add the feature to
* @param {geo.quadFeature.spec} spec The object specification
Expand Down
2 changes: 1 addition & 1 deletion src/vectorFeature.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ var feature = require('./feature');
/**
* Create a new instance of class vectorFeature
*
* @class
* @class geo.vectorFeature
* @extends geo.feature
* @returns {geo.vectorFeature}
*/
Expand Down

0 comments on commit 82e023d

Please sign in to comment.