Fix some module links

This commit is contained in:
ahocevar
2018-04-27 07:22:13 +02:00
parent 59d904e509
commit 3a365fab56
3 changed files with 15 additions and 17 deletions

View File

@@ -252,7 +252,7 @@ Feature.prototype.setStyle = function(style) {
* Set the feature id. The feature id is considered stable and may be used when * Set the feature id. The feature id is considered stable and may be used when
* requesting features or comparing identifiers returned from a remote source. * requesting features or comparing identifiers returned from a remote source.
* The feature id can be used with the * The feature id can be used with the
* {@link module:ol/source/Vector#getFeatureById} method. * {@link module:ol/source/Vector~VectorSource#getFeatureById} method.
* @param {number|string|undefined} id The feature id. * @param {number|string|undefined} id The feature id.
* @api * @api
* @fires module:ol/events/Event~Event#event:change * @fires module:ol/events/Event~Event#event:change

View File

@@ -27,7 +27,7 @@ import {assign} from '../obj.js';
* @classdesc * @classdesc
* Abstract base class; normally only used for creating subclasses and not * Abstract base class; normally only used for creating subclasses and not
* instantiated in apps. * instantiated in apps.
* Note that with `module:ol/layer/BaseLayer` and all its subclasses, any property set in * Note that with {@link module:ol/layer/Base} and all its subclasses, any property set in
* the options is set as a {@link module:ol/Object property on the layer object, so * the options is set as a {@link module:ol/Object property on the layer object, so
* is observable, and has get/set accessors. * is observable, and has get/set accessors.
* *

View File

@@ -33,7 +33,7 @@ import RBush from '../structs/RBush.js';
/** /**
* @classdesc * @classdesc
* Events emitted by {@link module:ol/source/VectorSource} instances are instances of this * Events emitted by {@link module:ol/source/Vector} instances are instances of this
* type. * type.
* *
* @constructor * @constructor
@@ -73,7 +73,7 @@ inherits(VectorSourceEvent, Event);
* Example: * Example:
* *
* ```js * ```js
* var vectorSource = new module:ol/source/VectorSource({ * var vectorSource = new VectorSource({
* format: new ol.format.GeoJSON(), * format: new ol.format.GeoJSON(),
* loader: function(extent, resolution, projection) { * loader: function(extent, resolution, projection) {
* var proj = projection.getCode(); * var proj = projection.getCode();
@@ -128,15 +128,15 @@ inherits(VectorSourceEvent, Event);
* `false` may improve performance. * `false` may improve performance.
* *
* Note that * Note that
* {@link module:ol/source/VectorSource#getFeaturesInExtent}, * {@link module:ol/source/Vector~VectorSource#getFeaturesInExtent},
* {@link module:ol/source/VectorSource#getClosestFeatureToCoordinate} and * {@link module:ol/source/Vector~VectorSource#getClosestFeatureToCoordinate} and
* {@link module:ol/source/VectorSource#getExtent} cannot be used when `useSpatialIndex` is * {@link module:ol/source/Vector~VectorSource#getExtent} cannot be used when `useSpatialIndex` is
* set to `false`, and {@link module:ol/source/VectorSource#forEachFeatureInExtent} will loop * set to `false`, and {@link module:ol/source/Vector~VectorSource#forEachFeatureInExtent} will loop
* through all features. * through all features.
* *
* When set to `false`, the features will be maintained in an * When set to `false`, the features will be maintained in an
* {@link module:ol/Collection}, which can be retrieved through * {@link module:ol/Collection}, which can be retrieved through
* {@link module:ol/source/VectorSource#getFeaturesCollection}. * {@link module:ol/source/Vector~VectorSource#getFeaturesCollection}.
* @property {boolean} [wrapX=true] Wrap the world horizontally. For vector editing across the * @property {boolean} [wrapX=true] Wrap the world horizontally. For vector editing across the
* -180° and 180° meridians to work properly, this should be set to `false`. The * -180° and 180° meridians to work properly, this should be set to `false`. The
* resulting geometry coordinates will then exceed the world bounds. * resulting geometry coordinates will then exceed the world bounds.
@@ -275,7 +275,7 @@ inherits(VectorSource, Source);
/** /**
* Add a single feature to the source. If you want to add a batch of features * Add a single feature to the source. If you want to add a batch of features
* at once, call {@link module:ol/source/VectorSource#addFeatures source.addFeatures()} * at once, call {@link module:ol/source/Vector~VectorSource#addFeatures #addFeatures()}
* instead. A feature will not be added to the source if feature with * instead. A feature will not be added to the source if feature with
* the same id is already there. The reason for this behavior is to avoid * the same id is already there. The reason for this behavior is to avoid
* feature duplication when using bbox or tile loading strategies. * feature duplication when using bbox or tile loading strategies.
@@ -454,7 +454,7 @@ VectorSource.prototype.bindFeaturesCollection_ = function(collection) {
/** /**
* Remove all features from the source. * Remove all features from the source.
* @param {boolean=} opt_fast Skip dispatching of {@link removefeature} events. * @param {boolean=} opt_fast Skip dispatching of {@link module:ol/source/Vector~VectorSourceEvent#removefeature} events.
* @api * @api
*/ */
VectorSource.prototype.clear = function(opt_fast) { VectorSource.prototype.clear = function(opt_fast) {
@@ -545,11 +545,10 @@ VectorSource.prototype.forEachFeatureAtCoordinateDirect = function(coordinate, c
* value, iteration will stop and the function will return the same value. * value, iteration will stop and the function will return the same value.
* *
* If you are interested in features whose geometry intersects an extent, call * If you are interested in features whose geometry intersects an extent, call
* the {@link module:ol/source/VectorSource#forEachFeatureIntersectingExtent * the {@link module:ol/source/Vector~VectorSource#forEachFeatureIntersectingExtent #forEachFeatureIntersectingExtent()} method instead.
* source.forEachFeatureIntersectingExtent()} method instead.
* *
* When `useSpatialIndex` is set to false, this method will loop through all * When `useSpatialIndex` is set to false, this method will loop through all
* features, equivalent to {@link module:ol/source/VectorSource#forEachFeature}. * features, equivalent to {@link module:ol/source/Vector~VectorSource#forEachFeature #forEachFeature()}.
* *
* @param {module:ol/extent~Extent} extent Extent. * @param {module:ol/extent~Extent} extent Extent.
* @param {function(module:ol/Feature): T} callback Called with each feature * @param {function(module:ol/Feature): T} callback Called with each feature
@@ -573,8 +572,7 @@ VectorSource.prototype.forEachFeatureInExtent = function(extent, callback) {
* value, iteration will stop and the function will return the same value. * value, iteration will stop and the function will return the same value.
* *
* If you only want to test for bounding box intersection, call the * If you only want to test for bounding box intersection, call the
* {@link module:ol/source/VectorSource#forEachFeatureInExtent * {@link module:ol/source/Vector~VectorSource#forEachFeatureInExtent #forEachFeatureInExtent()} method instead.
* source.forEachFeatureInExtent()} method instead.
* *
* @param {module:ol/extent~Extent} extent Extent. * @param {module:ol/extent~Extent} extent Extent.
* @param {function(module:ol/Feature): T} callback Called with each feature * @param {function(module:ol/Feature): T} callback Called with each feature
@@ -910,7 +908,7 @@ VectorSource.prototype.removeLoadedExtent = function(extent) {
/** /**
* Remove a single feature from the source. If you want to remove all features * Remove a single feature from the source. If you want to remove all features
* at once, use the {@link module:ol/source/VectorSource#clear source.clear()} method * at once, use the {@link module:ol/source/Vector~VectorSource#clear #clear()} method
* instead. * instead.
* @param {module:ol/Feature} feature Feature to remove. * @param {module:ol/Feature} feature Feature to remove.
* @api * @api