Partial valid-jsdoc corrections

This commit is contained in:
Tim Schaub
2016-01-08 12:38:34 -07:00
parent b1d00af58b
commit e6f6dcc230
21 changed files with 85 additions and 78 deletions

View File

@@ -19,7 +19,7 @@ goog.require('ol.source.Vector');
* Layer source to cluster vector data.
*
* @constructor
* @param {olx.source.ClusterOptions} options
* @param {olx.source.ClusterOptions} options Constructor options.
* @extends {ol.source.Vector}
* @api
*/
@@ -148,7 +148,7 @@ ol.source.Cluster.prototype.cluster_ = function() {
/**
* @param {Array.<ol.Feature>} features Features
* @return {ol.Feature}
* @return {ol.Feature} The cluster feature.
* @private
*/
ol.source.Cluster.prototype.createCluster_ = function(features) {

View File

@@ -13,7 +13,7 @@ goog.require('ol.source.Image');
*
* @constructor
* @extends {ol.source.Image}
* @param {olx.source.ImageCanvasOptions} options
* @param {olx.source.ImageCanvasOptions} options Constructor options.
* @api
*/
ol.source.ImageCanvas = function(options) {

View File

@@ -269,7 +269,7 @@ ol.source.TileUTFGridTile_.prototype.getImage = function(opt_context) {
/**
* Synchronously returns data at given coordinate (if available).
* @param {ol.Coordinate} coordinate Coordinate.
* @return {Object}
* @return {Object} The data.
*/
ol.source.TileUTFGridTile_.prototype.getData = function(coordinate) {
if (!this.grid_ || !this.keys_ || !this.data_) {
@@ -346,7 +346,7 @@ ol.source.TileUTFGridTile_.prototype.handleError_ = function() {
/**
* @param {!UTFGridJSON} json
* @param {!UTFGridJSON} json UTFGrid data.
* @private
*/
ol.source.TileUTFGridTile_.prototype.handleLoad_ = function(json) {

View File

@@ -221,8 +221,8 @@ ol.source.Vector.prototype.addFeatureInternal = function(feature) {
/**
* @param {string} featureKey
* @param {ol.Feature} feature
* @param {string} featureKey Unique identifier for the feature.
* @param {ol.Feature} feature The feature.
* @private
*/
ol.source.Vector.prototype.setupChangeEvents_ = function(featureKey, feature) {
@@ -240,10 +240,10 @@ ol.source.Vector.prototype.setupChangeEvents_ = function(featureKey, feature) {
/**
* @param {string} featureKey
* @param {ol.Feature} feature
* @return {boolean} `true` if the feature is "valid", in the sense that it is
* also a candidate for insertion into the Rtree, otherwise `false`.
* @param {string} featureKey Unique identifier for the feature.
* @param {ol.Feature} feature The feature.
* @return {boolean} The feature is "valid", in the sense that it is also a
* candidate for insertion into the Rtree.
* @private
*/
ol.source.Vector.prototype.addToIndex_ = function(featureKey, feature) {
@@ -536,7 +536,7 @@ ol.source.Vector.prototype.forEachFeatureIntersectingExtent =
* Get the features collection associated with this source. Will be `null`
* unless the source was configured with `useSpatialIndex` set to `false`, or
* with an {@link ol.Collection} as `features`.
* @return {ol.Collection.<ol.Feature>}
* @return {ol.Collection.<ol.Feature>} The collection of features.
* @api
*/
ol.source.Vector.prototype.getFeaturesCollection = function() {