ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Minor apidoc updates

Browse Source
This commit is contained in:
Frederic Junod
2013-11-04 09:58:39 +01:00
parent 32c2b5311e
commit 6e88d3ba3c
8 changed files with 57 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

74
src/objectliterals.jsdoc
View File

@@ -357,7 +357,7 @@
* modifier (i.e. Shift key) that determines if the interaction is active * modifier (i.e. Shift key) that determines if the interaction is active
* or not, default is no modifiers. * or not, default is no modifiers.
* @property {number|undefined} pixelDelta Pixel The amount to pan on each key * @property {number|undefined} pixelDelta Pixel The amount to pan on each key
* press * press. Default is `128` pixels.
* @todo stability experimental * @todo stability experimental
*/ */
@@ -367,7 +367,7 @@
* @property {ol.events.ConditionType|undefined} condition A conditional * @property {ol.events.ConditionType|undefined} condition A conditional
* modifier (i.e. Shift key) that determines if the interaction is active * modifier (i.e. Shift key) that determines if the interaction is active
* or not, default is no modifiers. * or not, default is no modifiers.
* @property {number|undefined} delta The amount to zoom on each key press. * @property {number|undefined} delta The amount to zoom on each key press. Default is `1`.
* @todo stability experimental * @todo stability experimental
*/ */
@@ -409,7 +409,8 @@
/** /**
* @typedef {Object} ol.interaction.TouchRotateOptions * @typedef {Object} ol.interaction.TouchRotateOptions
* @property {number|undefined} threshold Minimal angle to start a rotation. * @property {number|undefined} threshold Minimal angle in radians to start a rotation.
* Default is `0.3`.
* @todo stability experimental * @todo stability experimental
*/ */
@@ -421,12 +422,12 @@
/** /**
* @typedef {Object} ol.layer.BaseOptions * @typedef {Object} ol.layer.BaseOptions
* @property {number|undefined} brightness Brightness. * @property {number|undefined} brightness Brightness. Default is `0`.
* @property {number|undefined} contrast Contrast. * @property {number|undefined} contrast Contrast. Default is `1`.
* @property {number|undefined} hue Hue. * @property {number|undefined} hue Hue. Default is `0`.
* @property {number|undefined} opacity Opacity. * @property {number|undefined} opacity Opacity (0, 1). Default is `1`.
* @property {number|undefined} saturation Saturation. * @property {number|undefined} saturation Saturation. Default is `1`.
* @property {boolean|undefined} visible Visibility. * @property {boolean|undefined} visible Visibility. Default is `true`.
* @property {number|undefined} minResolution The minimum resolution * @property {number|undefined} minResolution The minimum resolution
* (inclusive) at which this layer will be visible. * (inclusive) at which this layer will be visible.
* @property {number|undefined} maxResolution The maximum resolution * @property {number|undefined} maxResolution The maximum resolution
@@ -436,11 +437,11 @@
/** /**
* @typedef {Object} ol.layer.LayerOptions * @typedef {Object} ol.layer.LayerOptions
* @property {number|undefined} brightness Brightness. * @property {number|undefined} brightness Brightness. Default is `0`.
* @property {number|undefined} contrast Contrast. * @property {number|undefined} contrast Contrast. Default is `1`.
* @property {number|undefined} hue Hue. * @property {number|undefined} hue Hue. Default is `0`.
* @property {number|undefined} opacity Opacity. 0-1. Default is `1`. * @property {number|undefined} opacity Opacity (0, 1). Default is `1`.
* @property {number|undefined} saturation Saturation. * @property {number|undefined} saturation Saturation. Default is `1`.
* @property {ol.source.Source} source Source for this layer. * @property {ol.source.Source} source Source for this layer.
* @property {boolean|undefined} visible Visibility. Default is `true` (visible). * @property {boolean|undefined} visible Visibility. Default is `true` (visible).
* @property {number|undefined} minResolution The minimum resolution * @property {number|undefined} minResolution The minimum resolution
@@ -452,12 +453,12 @@
/** /**
* @typedef {Object} ol.layer.GroupOptions * @typedef {Object} ol.layer.GroupOptions
* @property {number|undefined} brightness Brightness. * @property {number|undefined} brightness Brightness. Default is `0`.
* @property {number|undefined} contrast Contrast. * @property {number|undefined} contrast Contrast. Default is `1`.
* @property {number|undefined} hue Hue. * @property {number|undefined} hue Hue. Default is `0`.
* @property {number|undefined} opacity Opacity. * @property {number|undefined} opacity Opacity (0, 1). Default is `1`.
* @property {number|undefined} saturation Saturation. * @property {number|undefined} saturation Saturation. Default is `1`.
* @property {boolean|undefined} visible Visibility. * @property {boolean|undefined} visible Visibility. Default is `true`.
* @property {number|undefined} minResolution The minimum resolution * @property {number|undefined} minResolution The minimum resolution
* (inclusive) at which this layer will be visible. * (inclusive) at which this layer will be visible.
* @property {number|undefined} maxResolution The maximum resolution * @property {number|undefined} maxResolution The maximum resolution
@@ -468,12 +469,12 @@
/** /**
* @typedef {Object} ol.layer.TileOptions * @typedef {Object} ol.layer.TileOptions
* @property {number|undefined} brightness Brightness. * @property {number|undefined} brightness Brightness. Default is `0`.
* @property {number|undefined} contrast Contrast. * @property {number|undefined} contrast Contrast. Default is `1`.
* @property {number|undefined} hue Hue. * @property {number|undefined} hue Hue. Default is `0`.
* @property {number|undefined} opacity Opacity. 0-1. Default is `1`. * @property {number|undefined} opacity Opacity (0, 1). Default is `1`.
* @property {number|undefined} preload Preload. * @property {number|undefined} preload Preload.
* @property {number|undefined} saturation Saturation. * @property {number|undefined} saturation Saturation. Default is `1`.
* @property {ol.source.Source} source Source for this layer. * @property {ol.source.Source} source Source for this layer.
* @property {boolean|undefined} visible Visibility. Default is `true` (visible). * @property {boolean|undefined} visible Visibility. Default is `true` (visible).
* @property {number|undefined} minResolution The minimum resolution * @property {number|undefined} minResolution The minimum resolution
@@ -489,7 +490,7 @@
* Function to render an array of * Function to render an array of
* features into feature info markup. If not provided, a comma separated * features into feature info markup. If not provided, a comma separated
* list of the unique ids of the resulting features will be returned. * list of the unique ids of the resulting features will be returned.
* @property {number|undefined} opacity Opacity. 0-1. Default is `1`. * @property {number|undefined} opacity Opacity (0, 1). Default is `1`.
* @property {ol.source.Source} source Source for this layer. * @property {ol.source.Source} source Source for this layer.
* @property {ol.style.Style|undefined} style Style. * @property {ol.style.Style|undefined} style Style.
* @property {boolean|undefined} visible Visibility. Default is `true` (visible). * @property {boolean|undefined} visible Visibility. Default is `true` (visible).
@@ -587,7 +588,7 @@
/** /**
* @typedef {Object} ol.source.BingMapsOptions * @typedef {Object} ol.source.BingMapsOptions
* @property {string|undefined} culture Culture. * @property {string|undefined} culture Culture code. Default is `en-us`.
* @property {string} key Bing Maps API key. Get yours at * @property {string} key Bing Maps API key. Get yours at
* http://bingmapsportal.com/. * http://bingmapsportal.com/.
* @property {string} imagerySet Type of imagery. * @property {string} imagerySet Type of imagery.
@@ -617,7 +618,9 @@
* @property {number|undefined} maxZoom Max zoom. * @property {number|undefined} maxZoom Max zoom.
* @property {ol.TileLoadFunctionType|undefined} tileLoadFunction Optional * @property {ol.TileLoadFunctionType|undefined} tileLoadFunction Optional
* function to load a tile given a URL. * function to load a tile given a URL.
* @property {string|undefined} url URL. * @property {string|undefined} url URL template. Must include `{x}`, `{y}`,
* and `{z}` placeholders. Default is
* `http://{a-c}.tile.openstreetmap.org/{z}/{x}/{y}.png`.
* @todo stability experimental * @todo stability experimental
*/ */
@@ -651,7 +654,8 @@
* @property {boolean|undefined} opaque Whether the layer is opaque. * @property {boolean|undefined} opaque Whether the layer is opaque.
* @property {ol.TileLoadFunctionType|undefined} tileLoadFunction Optional * @property {ol.TileLoadFunctionType|undefined} tileLoadFunction Optional
* function to load a tile given a URL. * function to load a tile given a URL.
* @property {string|undefined} url URL. * @property {string|undefined} url URL template. Must include `{x}`, `{y}`,
* and `{z}` placeholders.
* @todo stability experimental * @todo stability experimental
*/ */
@@ -674,7 +678,7 @@
* requests. * requests.
* @property {ol.TileLoadFunctionType|undefined} tileLoadFunction Optional * @property {ol.TileLoadFunctionType|undefined} tileLoadFunction Optional
* function to load a tile given a URL. * function to load a tile given a URL.
* @property {string} url URL. * @property {string} url URL to the TileJSON file.
* @todo stability experimental * @todo stability experimental
*/ */
@@ -761,7 +765,7 @@
* requests. * requests.
* @property {ol.Extent|undefined} extent Extent. * @property {ol.Extent|undefined} extent Extent.
* @property {string|undefined} logo Logo. * @property {string|undefined} logo Logo.
* @property {ol.proj.ProjectionLike} projection Projection. * @property {ol.proj.ProjectionLike} projection Projection. Default is `EPSG:3857`.
* @property {number|undefined} maxZoom Optional max zoom level. Default is `18`. * @property {number|undefined} maxZoom Optional max zoom level. Default is `18`.
* @property {number|undefined} minZoom Unsupported (TODO: remove this). * @property {number|undefined} minZoom Unsupported (TODO: remove this).
* @property {ol.TileLoadFunctionType|undefined} tileLoadFunction Optional * @property {ol.TileLoadFunctionType|undefined} tileLoadFunction Optional
@@ -783,7 +787,7 @@
* @property {number|ol.expr.Expression|undefined} height Height of the * @property {number|ol.expr.Expression|undefined} height Height of the
* icon in pixels. Default is the height of the icon image. * icon in pixels. Default is the height of the icon image.
* @property {number|ol.expr.Expression|undefined} opacity Icon opacity * @property {number|ol.expr.Expression|undefined} opacity Icon opacity
* (0-1). * (0, 1). Default is `1`.
* @property {number|ol.expr.Expression|undefined} rotation Rotation in * @property {number|ol.expr.Expression|undefined} rotation Rotation in
* radians (positive rotation clockwise). * radians (positive rotation clockwise).
* @property {number|ol.expr.Expression|undefined} xOffset Pixel offset from the * @property {number|ol.expr.Expression|undefined} xOffset Pixel offset from the
@@ -798,7 +802,7 @@
* @typedef {Object} ol.style.FillOptions * @typedef {Object} ol.style.FillOptions
* @property {string|ol.expr.Expression|undefined} color Fill color as hex color * @property {string|ol.expr.Expression|undefined} color Fill color as hex color
* code. * code.
* @property {number|ol.expr.Expression|undefined} opacity Opacity (0-1). * @property {number|ol.expr.Expression|undefined} opacity Opacity (0, 1). Default is `1`.
* @property {number|ol.expr.Expression|undefined} zIndex Stack order. * @property {number|ol.expr.Expression|undefined} zIndex Stack order.
* @todo stability experimental * @todo stability experimental
*/ */
@@ -830,7 +834,7 @@
* @typedef {Object} ol.style.StrokeOptions * @typedef {Object} ol.style.StrokeOptions
* @property {string|ol.expr.Expression|undefined} color Stroke color as hex * @property {string|ol.expr.Expression|undefined} color Stroke color as hex
* color code. * color code.
* @property {number|ol.expr.Expression|undefined} opacity Stroke opacity (0-1). * @property {number|ol.expr.Expression|undefined} opacity Stroke opacity (0, 1). Default is `1`.
* @property {number|ol.expr.Expression|undefined} width Stroke width in pixels. * @property {number|ol.expr.Expression|undefined} width Stroke width in pixels.
* @property {number|ol.expr.Expression|undefined} zIndex Stack order. * @property {number|ol.expr.Expression|undefined} zIndex Stack order.
* @todo stability experimental * @todo stability experimental
@@ -852,7 +856,7 @@
* @property {number|ol.expr.Expression|undefined} fontSize Font size in pixels. * @property {number|ol.expr.Expression|undefined} fontSize Font size in pixels.
* @property {string|ol.expr.Expression|undefined} fontWeight Font weight. * @property {string|ol.expr.Expression|undefined} fontWeight Font weight.
* @property {string|ol.expr.Expression} text Text for the label. * @property {string|ol.expr.Expression} text Text for the label.
* @property {number|ol.expr.Expression|undefined} opacity Opacity (0-1). * @property {number|ol.expr.Expression|undefined} opacity Opacity (0, 1). Default is `1`.
* @property {ol.style.Stroke|undefined} stroke Stroke symbolizer for text. * @property {ol.style.Stroke|undefined} stroke Stroke symbolizer for text.
* @property {number|ol.expr.Expression|undefined} zIndex Stack order. * @property {number|ol.expr.Expression|undefined} zIndex Stack order.
* @todo stability experimental * @todo stability experimental

4
src/ol/control/mousepositioncontrol.js
View File

@@ -40,8 +40,8 @@ ol.control.MousePositionProperty = {
* @todo stability experimental * @todo stability experimental
* @todo observable projection {ol.proj.Projection} the projection to report * @todo observable projection {ol.proj.Projection} the projection to report
* mouse position in * mouse position in
* @todo observable coordinateFormat {string} the format to render the current * @todo observable coordinateFormat {ol.CoordinateFormatType} the format to
* position in * render the current position in
*/ */
ol.control.MousePosition = function(opt_options) { ol.control.MousePosition = function(opt_options) {

5
src/ol/geolocation.js
View File

@@ -62,8 +62,9 @@ ol.GeolocationProperty = {
* @todo observable speed {number} readonly the instantaneous speed of the * @todo observable speed {number} readonly the instantaneous speed of the
* device in meters per second * device in meters per second
* @todo observable tracking {number} track the device's position. * @todo observable tracking {number} track the device's position.
* @todo observable trackingOptions {number} PositionOptions as defined by the * @todo observable trackingOptions {GeolocationPositionOptions} PositionOptions
* HTML5 Geolocation spec at http://dev.w3.org/geo/api/spec-source.html * as defined by the HTML5 Geolocation spec at
* http://dev.w3.org/geo/api/spec-source.html
*/ */
ol.Geolocation = function(opt_options) { ol.Geolocation = function(opt_options) {

2
src/ol/geom/linearring.js
View File

@@ -10,7 +10,7 @@ goog.require('ol.geom.LineString');
* @constructor * @constructor
* @extends {ol.geom.LineString} * @extends {ol.geom.LineString}
* @param {ol.CoordinateArray} coordinates Vertex array (e.g. * @param {ol.CoordinateArray} coordinates Vertex array (e.g.
* [[x0, y0], [x1, y1]]). * `[[x0, y0], [x1, y1]]`).
* @todo stability experimental * @todo stability experimental
*/ */
ol.geom.LinearRing = function(coordinates) { ol.geom.LinearRing = function(coordinates) {

2
src/ol/geom/linestring.js
View File

@@ -15,7 +15,7 @@ goog.require('ol.geom.GeometryType');
* @constructor * @constructor
* @extends {ol.geom.Geometry} * @extends {ol.geom.Geometry}
* @param {ol.CoordinateArray} coordinates Array of coordinates (e.g. * @param {ol.CoordinateArray} coordinates Array of coordinates (e.g.
* [[x0, y0], [x1, y1]]). * `[[x0, y0], [x1, y1]]`).
* @todo stability experimental * @todo stability experimental
*/ */
ol.geom.LineString = function(coordinates) { ol.geom.LineString = function(coordinates) {

2
src/ol/geom/point.js
View File

@@ -12,7 +12,7 @@ goog.require('ol.geom.GeometryType');
/** /**
* @constructor * @constructor
* @extends {ol.geom.Geometry} * @extends {ol.geom.Geometry}
* @param {ol.Coordinate} coordinates Coordinate values (e.g. [x, y]). * @param {ol.Coordinate} coordinates Coordinate values (e.g. `[x, y]`).
* @todo stability experimental * @todo stability experimental
*/ */
ol.geom.Point = function(coordinates) { ol.geom.Point = function(coordinates) {

14
src/ol/object.js
View File

@@ -142,7 +142,7 @@ ol.Object.getAccessors = function(obj) {
/** /**
* @param {string} key Key. * @param {string} key Key name.
* @return {string} Change name. * @return {string} Change name.
*/ */
ol.Object.getChangeEventType = function(key) { ol.Object.getChangeEventType = function(key) {
@@ -207,7 +207,7 @@ ol.Object.getSetterName = function(key) {
* } * }
* ); * );
* *
* @param {string} key Key. * @param {string} key Key name.
* @param {ol.Object} target Target. * @param {ol.Object} target Target.
* @param {string=} opt_targetKey Target key. * @param {string=} opt_targetKey Target key.
* @return {ol.ObjectAccessor} * @return {ol.ObjectAccessor}
@@ -231,7 +231,7 @@ ol.Object.prototype.bindTo = function(key, target, opt_targetKey) {
/** /**
* Gets a value. * Gets a value.
* @param {string} key Key. * @param {string} key Key name.
* @return {*} Value. * @return {*} Value.
* @todo stability experimental * @todo stability experimental
*/ */
@@ -291,7 +291,7 @@ ol.Object.prototype.getKeys = function() {
* Notify all observers of a change on this property. This notifies both * Notify all observers of a change on this property. This notifies both
* objects that are bound to the object's property as well as the object * objects that are bound to the object's property as well as the object
* that it is bound to. * that it is bound to.
* @param {string} key Key. * @param {string} key Key name.
* @todo stability experimental * @todo stability experimental
*/ */
ol.Object.prototype.notify = function(key) { ol.Object.prototype.notify = function(key) {
@@ -308,7 +308,7 @@ ol.Object.prototype.notify = function(key) {
/** /**
* @param {string} key Key. * @param {string} key Key name.
* @private * @private
*/ */
ol.Object.prototype.notifyInternal_ = function(key) { ol.Object.prototype.notifyInternal_ = function(key) {
@@ -348,7 +348,7 @@ ol.Object.prototype.once = function(type, listener, opt_scope) {
/** /**
* Sets a value. * Sets a value.
* @param {string} key Key. * @param {string} key Key name.
* @param {*} value Value. * @param {*} value Value.
* @todo stability experimental * @todo stability experimental
*/ */
@@ -394,7 +394,7 @@ ol.Object.prototype.setValues = function(values) {
/** /**
* Removes a binding. Unbinding will set the unbound property to the current * Removes a binding. Unbinding will set the unbound property to the current
* value. The object will not be notified, as the value has not changed. * value. The object will not be notified, as the value has not changed.
* @param {string} key Key. * @param {string} key Key name.
* @todo stability experimental * @todo stability experimental
*/ */
ol.Object.prototype.unbind = function(key) { ol.Object.prototype.unbind = function(key) {

6
src/ol/view2d.js
View File

@@ -192,8 +192,8 @@ ol.View2D.prototype.constrainCenter = function(center) {
/** /**
* Get the constrained the resolution of this view. * Get the constrained the resolution of this view.
* @param {number|undefined} resolution Resolution. * @param {number|undefined} resolution Resolution.
* @param {number=} opt_delta Delta. * @param {number=} opt_delta Delta. Default is `0`.
* @param {number=} opt_direction Direction. * @param {number=} opt_direction Direction. Default is `0`.
* @return {number|undefined} Constrained resolution. * @return {number|undefined} Constrained resolution.
* @todo stability experimental * @todo stability experimental
*/ */
@@ -208,7 +208,7 @@ ol.View2D.prototype.constrainResolution = function(
/** /**
* Get the constrained rotation of this view. * Get the constrained rotation of this view.
* @param {number|undefined} rotation Rotation. * @param {number|undefined} rotation Rotation.
* @param {number=} opt_delta Delta. * @param {number=} opt_delta Delta. Default is `0`.
* @return {number|undefined} Constrained rotation. * @return {number|undefined} Constrained rotation.
* @todo stability experimental * @todo stability experimental
*/ */