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

Use @api annotation instead of @todo api

Browse Source
This commit is contained in:
Tim Schaub
2014-07-05 15:41:14 -04:00
parent 297503e7c9
commit 4cf5ab4620
155 changed files with 759 additions and 757 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
apidoc/plugins/todo.js
View File

@@ -6,9 +6,7 @@ exports.defineTags = function(dictionary) {
canHaveName: true, canHaveName: true,
onTagged: function(doclet, tag) { onTagged: function(doclet, tag) {
var parts = tag.text.split(' '); var parts = tag.text.split(' ');
if (parts[0] === 'api') { if (parts[0] === 'observable') {
doclet.stability = parts.slice(1).join(' ') || 'experimental';
} else if (parts[0] === 'observable') {
doclet.observable = ''; doclet.observable = '';
} }
} }

8
apidoc/readme.md
View File

@@ -11,7 +11,7 @@ In the simplest case, a JSDoc block can look like this:
/** /**
* Add the given control to the map. * Add the given control to the map.
* @param {ol.control.Control} control Control. * @param {ol.control.Control} control Control.
* @todo api * @api
*/ */
ol.Map.prototype.addControl = function(control) { ol.Map.prototype.addControl = function(control) {
// ... // ...
@@ -22,7 +22,7 @@ contain Markdown.
The second line tells the Closure compiler the type of the argument. The second line tells the Closure compiler the type of the argument.
The third line (`@todo api`) marks the method as part of the api and thus exportable. The stability can be added as value, e.g. `@todo api stable`. Once the documentation story is fully settled, we will remove the `todo ` and just write `@api` or `@api stable`. Without such an api annotation, the method will not be documented in the generated API documentation. Symbols without an api annotation will also not be exportable (unless they are explicitly exported with a `goog.exportProperty` call). The third line (`@api`) marks the method as part of the api and thus exportable. The stability can be added as value, e.g. `@api stable`. Without such an api annotation, the method will not be documented in the generated API documentation. Symbols without an api annotation will also not be exportable (unless they are explicitly exported with a `goog.exportProperty` call).
### Events ### Events
@@ -37,7 +37,7 @@ ol.MapBrowserEvent.EventType = {
* A true single click with no dragging and no double click. Note that this * A true single click with no dragging and no double click. Note that this
* event is delayed by 250 ms to ensure that it is not a double click. * event is delayed by 250 ms to ensure that it is not a double click.
* @event ol.MapBrowserEvent#singleclick * @event ol.MapBrowserEvent#singleclick
* @todo api * @api
*/ */
SINGLECLICK: 'singleclick', SINGLECLICK: 'singleclick',
// ... // ...
@@ -52,7 +52,7 @@ oli.MapBrowserEvent;
/** /**
* @type {ol.Coordinate} * @type {ol.Coordinate}
* @todo api * @api
*/ */
oli.MapBrowserEvent.prototype.coordinate; oli.MapBrowserEvent.prototype.coordinate;

2
build.py
View File

@@ -359,7 +359,7 @@ virtual('lint', 'build/lint-timestamp', 'build/check-requires-timestamp',
def build_lint_src_timestamp(t): def build_lint_src_timestamp(t):
t.run('%(GJSLINT)s', t.run('%(GJSLINT)s',
'--jslint_error=all', '--jslint_error=all',
'--custom_jsdoc_tags=event,fires,todo,function,classdesc', '--custom_jsdoc_tags=event,fires,todo,function,classdesc,api',
'--strict', '--strict',
t.newer(t.dependencies)) t.newer(t.dependencies))
t.touch() t.touch()

3
buildcfg/examples-all.json
View File

@@ -55,6 +55,9 @@
"uselessCode", "uselessCode",
"visibility" "visibility"
], ],
"extra_annotation_name": [
"api"
],
"jscomp_off": [ "jscomp_off": [
"es5Strict" "es5Strict"
], ],

15
buildcfg/jsdoc/info/api-plugin.js Normal file
View File

@@ -0,0 +1,15 @@
/**
* Handle the api annotation.
* @param {Object} dictionary The tag dictionary.
*/
exports.defineTags = function(dictionary) {
dictionary.defineTag('api', {
onTagged: function(doclet, tag) {
doclet.api = tag.text || 'experimental';
}
});
};

4
buildcfg/jsdoc/info/conf.json
View File

@@ -10,7 +10,7 @@
"includePattern": "\\.js$" "includePattern": "\\.js$"
}, },
"plugins": [ "plugins": [
"buildcfg/jsdoc/info/define-plugin", "buildcfg/jsdoc/info/api-plugin",
"buildcfg/jsdoc/info/todo-plugin" "buildcfg/jsdoc/info/define-plugin"
] ]
} }

26
buildcfg/jsdoc/info/todo-plugin.js
View File

@@ -1,26 +0,0 @@
/**
* @fileoverview This plugin should go away when we get rid of Plovr and can
* use Closure Compiler's extra_annotation_name option. Until then, we hijack
* the todo tag to add doclet properties for other tags we eventually want to
* support. For example, the "todo api" tag can eventually be replaced with
* the "api" tag.
*/
/**
* Our hook to define new tags.
* @param {Object} dictionary The tag dictionary.
*/
exports.defineTags = function(dictionary) {
dictionary.defineTag('todo', {
mustHaveValue: true,
onTagged: function(doclet, tag) {
var parts = tag.text.split(' ');
if (parts[0] === 'api') {
doclet.api = parts.slice(1).join(' ').trim();
}
}
});
};

3
buildcfg/ol-all.json
View File

@@ -52,6 +52,9 @@
"uselessCode", "uselessCode",
"visibility" "visibility"
], ],
"extra_annotation_name": [
"api"
],
"jscomp_off": [ "jscomp_off": [
"es5Strict" "es5Strict"
], ],

3
buildcfg/ol-simple.json
View File

@@ -52,6 +52,9 @@
"uselessCode", "uselessCode",
"visibility" "visibility"
], ],
"extra_annotation_name": [
"api"
],
"jscomp_off": [ "jscomp_off": [
"es5Strict" "es5Strict"
], ],

3
buildcfg/ol-whitespace.json
View File

@@ -52,6 +52,9 @@
"uselessCode", "uselessCode",
"visibility" "visibility"
], ],
"extra_annotation_name": [
"api"
],
"jscomp_off": [ "jscomp_off": [
"es5Strict" "es5Strict"
], ],

3
buildcfg/ol.json
View File

@@ -52,6 +52,9 @@
"uselessCode", "uselessCode",
"visibility" "visibility"
], ],
"extra_annotation_name": [
"api"
],
"jscomp_off": [ "jscomp_off": [
"es5Strict" "es5Strict"
], ],

192
externs/olx.js
View File

@@ -10,7 +10,7 @@ var olx;
/** /**
* @typedef {{html: string, * @typedef {{html: string,
* tileRanges: (Object.<string, Array.<ol.TileRange>>|undefined)}} * tileRanges: (Object.<string, Array.<ol.TileRange>>|undefined)}}
* @todo api * @api
*/ */
olx.AttributionOptions; olx.AttributionOptions;
@@ -32,7 +32,7 @@ olx.AttributionOptions.prototype.tileRanges;
/** /**
* @typedef {{loadTilesWhileAnimating: (boolean|undefined), * @typedef {{loadTilesWhileAnimating: (boolean|undefined),
* loadTilesWhileInteracting: (boolean|undefined)}} * loadTilesWhileInteracting: (boolean|undefined)}}
* @todo api * @api
*/ */
olx.DeviceOptions; olx.DeviceOptions;
@@ -55,7 +55,7 @@ olx.DeviceOptions.prototype.loadTilesWhileInteracting;
/** /**
* @typedef {{tracking: (boolean|undefined)}} * @typedef {{tracking: (boolean|undefined)}}
* @todo api * @api
*/ */
olx.DeviceOrientationOptions; olx.DeviceOrientationOptions;
@@ -71,7 +71,7 @@ olx.DeviceOrientationOptions.prototype.tracking;
* @typedef {{tracking: (boolean|undefined), * @typedef {{tracking: (boolean|undefined),
* trackingOptions: (GeolocationPositionOptions|undefined), * trackingOptions: (GeolocationPositionOptions|undefined),
* projection: ol.proj.ProjectionLike}} * projection: ol.proj.ProjectionLike}}
* @todo api * @api
*/ */
olx.GeolocationOptions; olx.GeolocationOptions;
@@ -111,7 +111,7 @@ olx.GeolocationOptions.prototype.projection;
* renderer: (ol.RendererType|Array.<ol.RendererType|string>|string|undefined), * renderer: (ol.RendererType|Array.<ol.RendererType|string>|string|undefined),
* target: (Element|string|undefined), * target: (Element|string|undefined),
* view: (ol.View|undefined)}} * view: (ol.View|undefined)}}
* @todo api * @api
*/ */
olx.MapOptions; olx.MapOptions;
@@ -216,7 +216,7 @@ olx.MapOptions.prototype.view;
* positioning: (ol.OverlayPositioning|string|undefined), * positioning: (ol.OverlayPositioning|string|undefined),
* stopEvent: (boolean|undefined), * stopEvent: (boolean|undefined),
* insertFirst: (boolean|undefined)}} * insertFirst: (boolean|undefined)}}
* @todo api * @api
*/ */
olx.OverlayOptions; olx.OverlayOptions;
@@ -279,7 +279,7 @@ olx.OverlayOptions.prototype.insertFirst;
* @typedef {{code: string, * @typedef {{code: string,
* extent: (ol.Extent|undefined), * extent: (ol.Extent|undefined),
* global: (boolean|undefined)}} * global: (boolean|undefined)}}
* @todo api * @api
*/ */
olx.Proj4jsProjectionOptions; olx.Proj4jsProjectionOptions;
@@ -312,7 +312,7 @@ olx.Proj4jsProjectionOptions.prototype.global;
* extent: (ol.Extent|undefined), * extent: (ol.Extent|undefined),
* axisOrientation: (string|undefined), * axisOrientation: (string|undefined),
* global: (boolean|undefined)}} * global: (boolean|undefined)}}
* @todo api * @api
*/ */
olx.ProjectionOptions; olx.ProjectionOptions;
@@ -368,7 +368,7 @@ olx.ProjectionOptions.prototype.global;
* rotation: (number|undefined), * rotation: (number|undefined),
* zoom: (number|undefined), * zoom: (number|undefined),
* zoomFactor: (number|undefined)}} * zoomFactor: (number|undefined)}}
* @todo api * @api
*/ */
olx.ViewOptions; olx.ViewOptions;
@@ -506,7 +506,7 @@ olx.ViewOptions.prototype.zoomFactor;
* start: (number|undefined), * start: (number|undefined),
* duration: (number|undefined), * duration: (number|undefined),
* easing: (function(number):number|undefined)}} * easing: (function(number):number|undefined)}}
* @todo api * @api
*/ */
olx.animation.BounceOptions; olx.animation.BounceOptions;
@@ -546,7 +546,7 @@ olx.animation.BounceOptions.prototype.easing;
* start: (number|undefined), * start: (number|undefined),
* duration: (number|undefined), * duration: (number|undefined),
* easing: (function(number):number|undefined)}} * easing: (function(number):number|undefined)}}
* @todo api * @api
*/ */
olx.animation.PanOptions; olx.animation.PanOptions;
@@ -586,7 +586,7 @@ olx.animation.PanOptions.prototype.easing;
* start: (number|undefined), * start: (number|undefined),
* duration: (number|undefined), * duration: (number|undefined),
* easing: (function(number):number|undefined)}} * easing: (function(number):number|undefined)}}
* @todo api * @api
*/ */
olx.animation.RotateOptions; olx.animation.RotateOptions;
@@ -634,7 +634,7 @@ olx.animation.RotateOptions.prototype.easing;
* start: (number|undefined), * start: (number|undefined),
* duration: (number|undefined), * duration: (number|undefined),
* easing: (function(number):number|undefined)}} * easing: (function(number):number|undefined)}}
* @todo api * @api
*/ */
olx.animation.ZoomOptions; olx.animation.ZoomOptions;
@@ -672,7 +672,7 @@ olx.animation.ZoomOptions.prototype.easing;
/** /**
* @typedef {{className: (string|undefined), * @typedef {{className: (string|undefined),
* target: (Element|undefined)}} * target: (Element|undefined)}}
* @todo api * @api
*/ */
olx.control.AttributionOptions; olx.control.AttributionOptions;
@@ -694,7 +694,7 @@ olx.control.AttributionOptions.prototype.target;
/** /**
* @typedef {{element: (Element|undefined), * @typedef {{element: (Element|undefined),
* target: (Element|string|undefined)}} * target: (Element|string|undefined)}}
* @todo api * @api
*/ */
olx.control.ControlOptions; olx.control.ControlOptions;
@@ -723,7 +723,7 @@ olx.control.ControlOptions.prototype.target;
* zoom: (boolean|undefined), * zoom: (boolean|undefined),
* rotateOptions: (olx.control.RotateOptions|undefined), * rotateOptions: (olx.control.RotateOptions|undefined),
* zoomOptions: (olx.control.ZoomOptions|undefined)}} * zoomOptions: (olx.control.ZoomOptions|undefined)}}
* @todo api * @api
*/ */
olx.control.DefaultsOptions; olx.control.DefaultsOptions;
@@ -789,7 +789,7 @@ olx.control.DefaultsOptions.prototype.zoomOptions;
* tipLabel: (string|undefined), * tipLabel: (string|undefined),
* keys: (boolean|undefined), * keys: (boolean|undefined),
* target: (Element|undefined)}} * target: (Element|undefined)}}
* @todo api * @api
*/ */
olx.control.FullScreenOptions; olx.control.FullScreenOptions;
@@ -825,7 +825,7 @@ olx.control.FullScreenOptions.prototype.target;
/** /**
* @typedef {{className: (string|undefined), * @typedef {{className: (string|undefined),
* target: (Element|undefined)}} * target: (Element|undefined)}}
* @todo api * @api
*/ */
olx.control.LogoOptions; olx.control.LogoOptions;
@@ -850,7 +850,7 @@ olx.control.LogoOptions.prototype.target;
* projection: ol.proj.ProjectionLike, * projection: ol.proj.ProjectionLike,
* target: (Element|undefined), * target: (Element|undefined),
* undefinedHTML: (string|undefined)}} * undefinedHTML: (string|undefined)}}
* @todo api * @api
*/ */
olx.control.MousePositionOptions; olx.control.MousePositionOptions;
@@ -895,7 +895,7 @@ olx.control.MousePositionOptions.prototype.undefinedHTML;
* minWidth: (number|undefined), * minWidth: (number|undefined),
* target: (Element|undefined), * target: (Element|undefined),
* units: (ol.control.ScaleLineUnits|string|undefined)}} * units: (ol.control.ScaleLineUnits|string|undefined)}}
* @todo api * @api
*/ */
olx.control.ScaleLineOptions; olx.control.ScaleLineOptions;
@@ -935,7 +935,7 @@ olx.control.ScaleLineOptions.prototype.units;
* tipLabel: (string|undefined), * tipLabel: (string|undefined),
* target: (Element|undefined), * target: (Element|undefined),
* autoHide: (boolean|undefined)}} * autoHide: (boolean|undefined)}}
* @todo api * @api
*/ */
olx.control.RotateOptions; olx.control.RotateOptions;
@@ -991,7 +991,7 @@ olx.control.RotateOptions.prototype.target;
* zoomOutTipLabel: (string|undefined), * zoomOutTipLabel: (string|undefined),
* delta: (number|undefined), * delta: (number|undefined),
* target: (Element|undefined)}} * target: (Element|undefined)}}
* @todo api * @api
*/ */
olx.control.ZoomOptions; olx.control.ZoomOptions;
@@ -1056,7 +1056,7 @@ olx.control.ZoomOptions.prototype.target;
* @typedef {{className: (string|undefined), * @typedef {{className: (string|undefined),
* maxResolution: (number|undefined), * maxResolution: (number|undefined),
* minResolution: (number|undefined)}} * minResolution: (number|undefined)}}
* @todo api * @api
*/ */
olx.control.ZoomSliderOptions; olx.control.ZoomSliderOptions;
@@ -1087,7 +1087,7 @@ olx.control.ZoomSliderOptions.prototype.minResolution;
* target: (Element|undefined), * target: (Element|undefined),
* tipLabel: (string|undefined), * tipLabel: (string|undefined),
* extent: (ol.Extent|undefined)}} * extent: (ol.Extent|undefined)}}
* @todo api * @api
*/ */
olx.control.ZoomToExtentOptions; olx.control.ZoomToExtentOptions;
@@ -1124,7 +1124,7 @@ olx.control.ZoomToExtentOptions.prototype.extent;
/** /**
* @typedef {{defaultProjection: ol.proj.ProjectionLike, * @typedef {{defaultProjection: ol.proj.ProjectionLike,
* geometryName: (string|undefined)}} * geometryName: (string|undefined)}}
* @todo api * @api
*/ */
olx.format.GeoJSONOptions; olx.format.GeoJSONOptions;
@@ -1160,7 +1160,7 @@ olx.format.PolylineOptions.prototype.factor;
/** /**
* @typedef {{defaultProjection: ol.proj.ProjectionLike}} * @typedef {{defaultProjection: ol.proj.ProjectionLike}}
* @todo api * @api
*/ */
olx.format.TopoJSONOptions; olx.format.TopoJSONOptions;
@@ -1174,7 +1174,7 @@ olx.format.TopoJSONOptions.prototype.defaultProjection;
/** /**
* @typedef {{altitudeMode: (ol.format.IGCZ|undefined)}} * @typedef {{altitudeMode: (ol.format.IGCZ|undefined)}}
* @todo api * @api
*/ */
olx.format.IGCOptions; olx.format.IGCOptions;
@@ -1189,7 +1189,7 @@ olx.format.IGCOptions.prototype.altitudeMode;
/** /**
* @typedef {{defaultStyle: (Array.<ol.style.Style>|undefined)}} * @typedef {{defaultStyle: (Array.<ol.style.Style>|undefined)}}
* @todo api * @api
*/ */
olx.format.KMLOptions; olx.format.KMLOptions;
@@ -1210,7 +1210,7 @@ olx.format.KMLOptions.prototype.defaultStyle;
* multiCurve: (boolean|undefined), * multiCurve: (boolean|undefined),
* multiSurface: (boolean|undefined), * multiSurface: (boolean|undefined),
* schemaLocation: (string|undefined)}} * schemaLocation: (string|undefined)}}
* @todo api * @api
*/ */
olx.format.GMLOptions; olx.format.GMLOptions;
@@ -1280,7 +1280,7 @@ olx.format.GMLOptions.prototype.schemaLocation;
* @typedef {{featureNS: string, * @typedef {{featureNS: string,
* featureType: string, * featureType: string,
* schemaLocation: (string|undefined)}} * schemaLocation: (string|undefined)}}
* @todo api * @api
*/ */
olx.format.WFSOptions; olx.format.WFSOptions;
@@ -1317,7 +1317,7 @@ olx.format.WFSOptions.prototype.schemaLocation;
* maxFeatures: (number|undefined), * maxFeatures: (number|undefined),
* geometryName: (string|undefined), * geometryName: (string|undefined),
* bbox: (ol.Extent|undefined)}} * bbox: (ol.Extent|undefined)}}
* @todo api * @api
*/ */
olx.format.WFSWriteGetFeatureOptions; olx.format.WFSWriteGetFeatureOptions;
@@ -1394,7 +1394,7 @@ olx.format.WFSWriteGetFeatureOptions.prototype.bbox;
* handle: (string|undefined), * handle: (string|undefined),
* nativeElements: Array.<Object>, * nativeElements: Array.<Object>,
* gmlOptions: (olx.format.GMLOptions|undefined)}} * gmlOptions: (olx.format.GMLOptions|undefined)}}
* @todo api * @api
*/ */
olx.format.WFSWriteTransactionOptions; olx.format.WFSWriteTransactionOptions;
@@ -1451,7 +1451,7 @@ olx.format.WFSWriteTransactionOptions.prototype.gmlOptions;
/** /**
* @typedef {{splitCollection: (boolean|undefined)}} * @typedef {{splitCollection: (boolean|undefined)}}
* @todo api * @api
*/ */
olx.format.WKTOptions; olx.format.WKTOptions;
@@ -1475,7 +1475,7 @@ olx.format.WKTOptions.prototype.splitCollection;
* pinchZoom: (boolean|undefined), * pinchZoom: (boolean|undefined),
* zoomDelta: (number|undefined), * zoomDelta: (number|undefined),
* zoomDuration: (number|undefined)}} * zoomDuration: (number|undefined)}}
* @todo api * @api
*/ */
olx.interaction.DefaultsOptions; olx.interaction.DefaultsOptions;
@@ -1553,7 +1553,7 @@ olx.interaction.DefaultsOptions.prototype.zoomDuration;
/** /**
* @typedef {{duration: (number|undefined), * @typedef {{duration: (number|undefined),
* delta: (number|undefined)}} * delta: (number|undefined)}}
* @todo api * @api
*/ */
olx.interaction.DoubleClickZoomOptions; olx.interaction.DoubleClickZoomOptions;
@@ -1575,7 +1575,7 @@ olx.interaction.DoubleClickZoomOptions.prototype.delta;
/** /**
* @typedef {{formatConstructors: (Array.<function(new: ol.format.Feature)>|undefined), * @typedef {{formatConstructors: (Array.<function(new: ol.format.Feature)>|undefined),
* reprojectTo: ol.proj.ProjectionLike}} * reprojectTo: ol.proj.ProjectionLike}}
* @todo api * @api
*/ */
olx.interaction.DragAndDropOptions; olx.interaction.DragAndDropOptions;
@@ -1597,7 +1597,7 @@ olx.interaction.DragAndDropOptions.prototype.reprojectTo;
/** /**
* @typedef {{condition: (ol.events.ConditionType|undefined), * @typedef {{condition: (ol.events.ConditionType|undefined),
* style: ol.style.Style}} * style: ol.style.Style}}
* @todo api * @api
*/ */
olx.interaction.DragBoxOptions; olx.interaction.DragBoxOptions;
@@ -1620,7 +1620,7 @@ olx.interaction.DragBoxOptions.prototype.style;
/** /**
* @typedef {{kinetic: (ol.Kinetic|undefined)}} * @typedef {{kinetic: (ol.Kinetic|undefined)}}
* @todo api * @api
*/ */
olx.interaction.DragPanOptions; olx.interaction.DragPanOptions;
@@ -1634,7 +1634,7 @@ olx.interaction.DragPanOptions.prototype.kinetic;
/** /**
* @typedef {{condition: (ol.events.ConditionType|undefined)}} * @typedef {{condition: (ol.events.ConditionType|undefined)}}
* @todo api * @api
*/ */
olx.interaction.DragRotateAndZoomOptions; olx.interaction.DragRotateAndZoomOptions;
@@ -1650,7 +1650,7 @@ olx.interaction.DragRotateAndZoomOptions.prototype.condition;
/** /**
* @typedef {{condition: (ol.events.ConditionType|undefined)}} * @typedef {{condition: (ol.events.ConditionType|undefined)}}
* @todo api * @api
*/ */
olx.interaction.DragRotateOptions; olx.interaction.DragRotateOptions;
@@ -1667,7 +1667,7 @@ olx.interaction.DragRotateOptions.prototype.condition;
/** /**
* @typedef {{condition: (ol.events.ConditionType|undefined), * @typedef {{condition: (ol.events.ConditionType|undefined),
* style: ol.style.Style}} * style: ol.style.Style}}
* @todo api * @api
*/ */
olx.interaction.DragZoomOptions; olx.interaction.DragZoomOptions;
@@ -1697,7 +1697,7 @@ olx.interaction.DragZoomOptions.prototype.style;
* style: (ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction|undefined), * style: (ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction|undefined),
* geometryName: (string|undefined), * geometryName: (string|undefined),
* condition: (ol.events.ConditionType|undefined)}} * condition: (ol.events.ConditionType|undefined)}}
* @todo api * @api
*/ */
olx.interaction.DrawOptions; olx.interaction.DrawOptions;
@@ -1765,7 +1765,7 @@ olx.interaction.DrawOptions.prototype.condition;
/** /**
* @typedef {{condition: (ol.events.ConditionType|undefined), * @typedef {{condition: (ol.events.ConditionType|undefined),
* pixelDelta: (number|undefined)}} * pixelDelta: (number|undefined)}}
* @todo api * @api
*/ */
olx.interaction.KeyboardPanOptions; olx.interaction.KeyboardPanOptions;
@@ -1791,7 +1791,7 @@ olx.interaction.KeyboardPanOptions.prototype.pixelDelta;
* @typedef {{duration: (number|undefined), * @typedef {{duration: (number|undefined),
* condition: (ol.events.ConditionType|undefined), * condition: (ol.events.ConditionType|undefined),
* delta: (number|undefined)}} * delta: (number|undefined)}}
* @todo api * @api
*/ */
olx.interaction.KeyboardZoomOptions; olx.interaction.KeyboardZoomOptions;
@@ -1824,7 +1824,7 @@ olx.interaction.KeyboardZoomOptions.prototype.delta;
* pixelTolerance: (number|undefined), * pixelTolerance: (number|undefined),
* style: (ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction|undefined), * style: (ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction|undefined),
* features: ol.Collection}} * features: ol.Collection}}
* @todo api * @api
*/ */
olx.interaction.ModifyOptions; olx.interaction.ModifyOptions;
@@ -1863,7 +1863,7 @@ olx.interaction.ModifyOptions.prototype.features;
/** /**
* @typedef {{duration: (number|undefined)}} * @typedef {{duration: (number|undefined)}}
* @todo api * @api
*/ */
olx.interaction.MouseWheelZoomOptions; olx.interaction.MouseWheelZoomOptions;
@@ -1877,7 +1877,7 @@ olx.interaction.MouseWheelZoomOptions.prototype.duration;
/** /**
* @typedef {{threshold: (number|undefined)}} * @typedef {{threshold: (number|undefined)}}
* @todo api * @api
*/ */
olx.interaction.PinchRotateOptions; olx.interaction.PinchRotateOptions;
@@ -1891,7 +1891,7 @@ olx.interaction.PinchRotateOptions.prototype.threshold;
/** /**
* @typedef {{duration: (number|undefined)}} * @typedef {{duration: (number|undefined)}}
* @todo api * @api
*/ */
olx.interaction.PinchZoomOptions; olx.interaction.PinchZoomOptions;
@@ -1910,7 +1910,7 @@ olx.interaction.PinchZoomOptions.prototype.duration;
* style: (ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction|undefined), * style: (ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction|undefined),
* removeCondition: (ol.events.ConditionType|undefined), * removeCondition: (ol.events.ConditionType|undefined),
* toggleCondition: (ol.events.ConditionType|undefined)}} * toggleCondition: (ol.events.ConditionType|undefined)}}
* @todo api * @api
*/ */
olx.interaction.SelectOptions; olx.interaction.SelectOptions;
@@ -1990,7 +1990,7 @@ olx.interaction.SelectOptions.prototype.toggleCondition;
* visible: (boolean|undefined), * visible: (boolean|undefined),
* minResolution: (number|undefined), * minResolution: (number|undefined),
* maxResolution: (number|undefined)}} * maxResolution: (number|undefined)}}
* @todo api * @api
*/ */
olx.layer.BaseOptions; olx.layer.BaseOptions;
@@ -2061,7 +2061,7 @@ olx.layer.BaseOptions.prototype.maxResolution;
* visible: (boolean|undefined), * visible: (boolean|undefined),
* minResolution: (number|undefined), * minResolution: (number|undefined),
* maxResolution: (number|undefined)}} * maxResolution: (number|undefined)}}
* @todo api * @api
*/ */
olx.layer.LayerOptions; olx.layer.LayerOptions;
@@ -2139,7 +2139,7 @@ olx.layer.LayerOptions.prototype.maxResolution;
* minResolution: (number|undefined), * minResolution: (number|undefined),
* maxResolution: (number|undefined), * maxResolution: (number|undefined),
* layers: (Array.<ol.layer.Base>|ol.Collection|undefined)}} * layers: (Array.<ol.layer.Base>|ol.Collection|undefined)}}
* @todo api * @api
*/ */
olx.layer.GroupOptions; olx.layer.GroupOptions;
@@ -2222,7 +2222,7 @@ olx.layer.GroupOptions.prototype.layers;
* saturation: (number|undefined), * saturation: (number|undefined),
* source: ol.source.Vector, * source: ol.source.Vector,
* visible: (boolean|undefined)}} * visible: (boolean|undefined)}}
* @todo api * @api
*/ */
olx.layer.HeatmapOptions; olx.layer.HeatmapOptions;
@@ -2340,7 +2340,7 @@ olx.layer.HeatmapOptions.prototype.visible;
* minResolution: (number|undefined), * minResolution: (number|undefined),
* maxResolution: (number|undefined), * maxResolution: (number|undefined),
* useInterimTilesOnError: (boolean|undefined)}} * useInterimTilesOnError: (boolean|undefined)}}
* @todo api * @api
*/ */
olx.layer.TileOptions; olx.layer.TileOptions;
@@ -2434,7 +2434,7 @@ olx.layer.TileOptions.prototype.useInterimTilesOnError;
* source: ol.source.Vector, * source: ol.source.Vector,
* style: (ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction|undefined), * style: (ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction|undefined),
* visible: (boolean|undefined)}} * visible: (boolean|undefined)}}
* @todo api * @api
*/ */
olx.layer.VectorOptions; olx.layer.VectorOptions;
@@ -2522,7 +2522,7 @@ olx.layer.VectorOptions.prototype.visible;
* @typedef {{features: (Array.<ol.Feature>|ol.Collection|undefined), * @typedef {{features: (Array.<ol.Feature>|ol.Collection|undefined),
* map: (ol.Map|undefined), * map: (ol.Map|undefined),
* style: (ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction|undefined)}} * style: (ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction|undefined)}}
* @todo api * @api
*/ */
olx.FeatureOverlayOptions; olx.FeatureOverlayOptions;
@@ -2553,7 +2553,7 @@ olx.FeatureOverlayOptions.prototype.style;
* key: string, * key: string,
* imagerySet: string, * imagerySet: string,
* tileLoadFunction: (ol.TileLoadFunctionType|undefined)}} * tileLoadFunction: (ol.TileLoadFunctionType|undefined)}}
* @todo api * @api
*/ */
olx.source.BingMapsOptions; olx.source.BingMapsOptions;
@@ -2592,7 +2592,7 @@ olx.source.BingMapsOptions.prototype.tileLoadFunction;
* format: ol.format.Feature, * format: ol.format.Feature,
* logo: (string|undefined), * logo: (string|undefined),
* projection: ol.proj.ProjectionLike}} * projection: ol.proj.ProjectionLike}}
* @todo api * @api
*/ */
olx.source.FormatVectorOptions; olx.source.FormatVectorOptions;
@@ -2642,7 +2642,7 @@ olx.source.FormatVectorOptions.prototype.projection;
* text: (string|undefined), * text: (string|undefined),
* url: (string|undefined), * url: (string|undefined),
* urls: (Array.<string>|undefined)}} * urls: (Array.<string>|undefined)}}
* @todo api * @api
*/ */
olx.source.GeoJSONOptions; olx.source.GeoJSONOptions;
@@ -2721,7 +2721,7 @@ olx.source.GeoJSONOptions.prototype.urls;
* text: (string|undefined), * text: (string|undefined),
* url: (string|undefined), * url: (string|undefined),
* urls: (Array.<string>|undefined)}} * urls: (Array.<string>|undefined)}}
* @todo api * @api
*/ */
olx.source.GPXOptions; olx.source.GPXOptions;
@@ -2804,7 +2804,7 @@ olx.source.GPXOptions.prototype.urls;
* tileLoadFunction: (ol.TileLoadFunctionType|undefined), * tileLoadFunction: (ol.TileLoadFunctionType|undefined),
* tilePixelRatio: (number|undefined), * tilePixelRatio: (number|undefined),
* tileUrlFunction: (ol.TileUrlFunctionType|undefined)}} * tileUrlFunction: (ol.TileUrlFunctionType|undefined)}}
* @todo api * @api
*/ */
olx.source.TileImageOptions; olx.source.TileImageOptions;
@@ -2903,7 +2903,7 @@ olx.source.TileImageOptions.prototype.tileUrlFunction;
* tileUrlFunction: (ol.TileUrlFunctionType|undefined), * tileUrlFunction: (ol.TileUrlFunctionType|undefined),
* url: (string|undefined), * url: (string|undefined),
* urls: (Array.<string>|undefined)}} * urls: (Array.<string>|undefined)}}
* @todo api * @api
*/ */
olx.source.TileVectorOptions; olx.source.TileVectorOptions;
@@ -2996,7 +2996,7 @@ olx.source.TileVectorOptions.prototype.urls;
* projection: ol.proj.ProjectionLike, * projection: ol.proj.ProjectionLike,
* text: (string|undefined), * text: (string|undefined),
* url: (string|undefined)}} * url: (string|undefined)}}
* @todo api * @api
*/ */
olx.source.TopoJSONOptions; olx.source.TopoJSONOptions;
@@ -3064,7 +3064,7 @@ olx.source.TopoJSONOptions.prototype.url;
* text: (string|undefined), * text: (string|undefined),
* url: (string|undefined), * url: (string|undefined),
* urls: (Array.<string>|undefined)}} * urls: (Array.<string>|undefined)}}
* @todo api * @api
*/ */
olx.source.IGCOptions; olx.source.IGCOptions;
@@ -3117,7 +3117,7 @@ olx.source.IGCOptions.prototype.urls;
* ratio: (number|undefined), * ratio: (number|undefined),
* resolutions: (Array.<number>|undefined), * resolutions: (Array.<number>|undefined),
* params: (Object|undefined)}} * params: (Object|undefined)}}
* @todo api * @api
*/ */
olx.source.MapGuideOptions; olx.source.MapGuideOptions;
@@ -3205,7 +3205,7 @@ olx.source.MapGuideOptions.prototype.params;
* text: (string|undefined), * text: (string|undefined),
* url: (string|undefined), * url: (string|undefined),
* urls: (Array.<string>|undefined)}} * urls: (Array.<string>|undefined)}}
* @todo api * @api
*/ */
olx.source.KMLOptions; olx.source.KMLOptions;
@@ -3284,7 +3284,7 @@ olx.source.KMLOptions.prototype.urls;
/** /**
* @typedef {{layer: string, * @typedef {{layer: string,
* tileLoadFunction: (ol.TileLoadFunctionType|undefined)}} * tileLoadFunction: (ol.TileLoadFunctionType|undefined)}}
* @todo api * @api
*/ */
olx.source.MapQuestOptions; olx.source.MapQuestOptions;
@@ -3307,7 +3307,7 @@ olx.source.MapQuestOptions.prototype.tileLoadFunction;
* @typedef {{extent: (ol.Extent|undefined), * @typedef {{extent: (ol.Extent|undefined),
* projection: ol.proj.ProjectionLike, * projection: ol.proj.ProjectionLike,
* tileGrid: (ol.tilegrid.TileGrid|undefined)}} * tileGrid: (ol.tilegrid.TileGrid|undefined)}}
* @todo api * @api
*/ */
olx.source.TileDebugOptions; olx.source.TileDebugOptions;
@@ -3339,7 +3339,7 @@ olx.source.TileDebugOptions.prototype.tileGrid;
* maxZoom: (number|undefined), * maxZoom: (number|undefined),
* tileLoadFunction: (ol.TileLoadFunctionType|undefined), * tileLoadFunction: (ol.TileLoadFunctionType|undefined),
* url: (string|undefined)}} * url: (string|undefined)}}
* @todo api * @api
*/ */
olx.source.OSMOptions; olx.source.OSMOptions;
@@ -3392,7 +3392,7 @@ olx.source.OSMOptions.prototype.url;
* text: (string|undefined), * text: (string|undefined),
* url: (string|undefined), * url: (string|undefined),
* urls: (Array.<string>|undefined)}} * urls: (Array.<string>|undefined)}}
* @todo api * @api
*/ */
olx.source.OSMXMLOptions; olx.source.OSMXMLOptions;
@@ -3483,7 +3483,7 @@ olx.source.OSMXMLOptions.prototype.urls;
* ratio: (number|undefined), * ratio: (number|undefined),
* resolutions: (Array.<number>|undefined), * resolutions: (Array.<number>|undefined),
* state: (ol.source.State|string|undefined)}} * state: (ol.source.State|string|undefined)}}
* @todo api * @api
*/ */
olx.source.ImageCanvasOptions; olx.source.ImageCanvasOptions;
@@ -3562,7 +3562,7 @@ olx.source.ImageCanvasOptions.prototype.state;
* resolutions: (Array.<number>|undefined), * resolutions: (Array.<number>|undefined),
* source: ol.source.Vector, * source: ol.source.Vector,
* style: (ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction|undefined)}} * style: (ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction|undefined)}}
* @todo api * @api
*/ */
olx.source.ImageVectorOptions; olx.source.ImageVectorOptions;
@@ -3638,7 +3638,7 @@ olx.source.ImageVectorOptions.prototype.style;
* ratio: (number|undefined), * ratio: (number|undefined),
* resolutions: (Array.<number>|undefined), * resolutions: (Array.<number>|undefined),
* url: (string|undefined)}} * url: (string|undefined)}}
* @todo api * @api
*/ */
olx.source.ImageWMSOptions; olx.source.ImageWMSOptions;
@@ -3732,7 +3732,7 @@ olx.source.ImageWMSOptions.prototype.url;
* opaque: (boolean|undefined), * opaque: (boolean|undefined),
* tileLoadFunction: (ol.TileLoadFunctionType|undefined), * tileLoadFunction: (ol.TileLoadFunctionType|undefined),
* url: (string|undefined)}} * url: (string|undefined)}}
* @todo api * @api
*/ */
olx.source.StamenOptions; olx.source.StamenOptions;
@@ -3788,7 +3788,7 @@ olx.source.StamenOptions.prototype.url;
* logo: (string|undefined), * logo: (string|undefined),
* projection: ol.proj.ProjectionLike, * projection: ol.proj.ProjectionLike,
* url: string}} * url: string}}
* @todo api * @api
*/ */
olx.source.ImageStaticOptions; olx.source.ImageStaticOptions;
@@ -3857,7 +3857,7 @@ olx.source.ImageStaticOptions.prototype.url;
* strategy: (function(ol.Extent, number): Array.<ol.Extent>|undefined), * strategy: (function(ol.Extent, number): Array.<ol.Extent>|undefined),
* logo: (string|undefined), * logo: (string|undefined),
* projection: ol.proj.ProjectionLike}} * projection: ol.proj.ProjectionLike}}
* @todo api * @api
*/ */
olx.source.ServerVectorOptions; olx.source.ServerVectorOptions;
@@ -3916,7 +3916,7 @@ olx.source.ServerVectorOptions.prototype.projection;
* @typedef {{crossOrigin: (null|string|undefined), * @typedef {{crossOrigin: (null|string|undefined),
* tileLoadFunction: (ol.TileLoadFunctionType|undefined), * tileLoadFunction: (ol.TileLoadFunctionType|undefined),
* url: string}} * url: string}}
* @todo api * @api
*/ */
olx.source.TileJSONOptions; olx.source.TileJSONOptions;
@@ -3957,7 +3957,7 @@ olx.source.TileJSONOptions.prototype.url;
* tileLoadFunction: (ol.TileLoadFunctionType|undefined), * tileLoadFunction: (ol.TileLoadFunctionType|undefined),
* url: (string|undefined), * url: (string|undefined),
* urls: (Array.<string>|undefined)}} * urls: (Array.<string>|undefined)}}
* @todo api * @api
*/ */
olx.source.TileWMSOptions; olx.source.TileWMSOptions;
@@ -4079,7 +4079,7 @@ olx.source.TileWMSOptions.prototype.urls;
* logo: (string|undefined), * logo: (string|undefined),
* projection: ol.proj.ProjectionLike, * projection: ol.proj.ProjectionLike,
* state: (ol.source.State|string|undefined)}} * state: (ol.source.State|string|undefined)}}
* @todo api * @api
*/ */
olx.source.VectorOptions; olx.source.VectorOptions;
@@ -4139,7 +4139,7 @@ olx.source.VectorOptions.prototype.state;
* text: (string|undefined), * text: (string|undefined),
* url: (string|undefined), * url: (string|undefined),
* urls: (Array.<string>|undefined)}} * urls: (Array.<string>|undefined)}}
* @todo api * @api
*/ */
olx.source.StaticVectorOptions; olx.source.StaticVectorOptions;
@@ -4247,7 +4247,7 @@ olx.source.StaticVectorOptions.prototype.urls;
* maxZoom: (number|undefined), * maxZoom: (number|undefined),
* tileLoadFunction: (ol.TileLoadFunctionType|undefined), * tileLoadFunction: (ol.TileLoadFunctionType|undefined),
* urls: (Array.<string>|undefined)}} * urls: (Array.<string>|undefined)}}
* @todo api * @api
*/ */
olx.source.WMTSOptions; olx.source.WMTSOptions;
@@ -4394,7 +4394,7 @@ olx.source.WMTSOptions.prototype.urls;
* url: (string|undefined), * url: (string|undefined),
* urls: (Array.<string>|undefined), * urls: (Array.<string>|undefined),
* wrapX: (boolean|undefined)}} * wrapX: (boolean|undefined)}}
* @todo api * @api
*/ */
olx.source.XYZOptions; olx.source.XYZOptions;
@@ -4491,7 +4491,7 @@ olx.source.XYZOptions.prototype.wrapX;
* url: !string, * url: !string,
* tierSizeCalculation: (string|undefined), * tierSizeCalculation: (string|undefined),
* size: ol.Size}} * size: ol.Size}}
* @todo api * @api
*/ */
olx.source.ZoomifyOptions; olx.source.ZoomifyOptions;
@@ -4543,7 +4543,7 @@ olx.source.ZoomifyOptions.prototype.size;
* radius: number, * radius: number,
* snapToPixel: (boolean|undefined), * snapToPixel: (boolean|undefined),
* stroke: (ol.style.Stroke|undefined)}} * stroke: (ol.style.Stroke|undefined)}}
* @todo api * @api
*/ */
olx.style.CircleOptions; olx.style.CircleOptions;
@@ -4584,7 +4584,7 @@ olx.style.CircleOptions.prototype.stroke;
/** /**
* @typedef {{color: (ol.Color|string|undefined)}} * @typedef {{color: (ol.Color|string|undefined)}}
* @todo api * @api
*/ */
olx.style.FillOptions; olx.style.FillOptions;
@@ -4611,7 +4611,7 @@ olx.style.FillOptions.prototype.color;
* rotation: (number|undefined), * rotation: (number|undefined),
* size: (ol.Size|undefined), * size: (ol.Size|undefined),
* src: (string|undefined)}} * src: (string|undefined)}}
* @todo api * @api
*/ */
olx.style.IconOptions; olx.style.IconOptions;
@@ -4736,7 +4736,7 @@ olx.style.IconOptions.prototype.src;
* lineDash: (Array.<number>|undefined), * lineDash: (Array.<number>|undefined),
* miterLimit: (number|undefined), * miterLimit: (number|undefined),
* width: (number|undefined)}} * width: (number|undefined)}}
* @todo api * @api
*/ */
olx.style.StrokeOptions; olx.style.StrokeOptions;
@@ -4794,7 +4794,7 @@ olx.style.StrokeOptions.prototype.width;
* textBaseline: (string|undefined), * textBaseline: (string|undefined),
* fill: (ol.style.Fill|undefined), * fill: (ol.style.Fill|undefined),
* stroke: (ol.style.Stroke|undefined)}} * stroke: (ol.style.Stroke|undefined)}}
* @todo api * @api
*/ */
olx.style.TextOptions; olx.style.TextOptions;
@@ -4877,7 +4877,7 @@ olx.style.TextOptions.prototype.stroke;
* stroke: (ol.style.Stroke|undefined), * stroke: (ol.style.Stroke|undefined),
* text: (ol.style.Text|undefined), * text: (ol.style.Text|undefined),
* zIndex: (number|undefined)}} * zIndex: (number|undefined)}}
* @todo api * @api
*/ */
olx.style.StyleOptions; olx.style.StyleOptions;
@@ -4924,7 +4924,7 @@ olx.style.StyleOptions.prototype.zIndex;
* resolutions: !Array.<number>, * resolutions: !Array.<number>,
* tileSize: (number|undefined), * tileSize: (number|undefined),
* tileSizes: (Array.<number>|undefined)}} * tileSizes: (Array.<number>|undefined)}}
* @todo api * @api
*/ */
olx.tilegrid.TileGridOptions; olx.tilegrid.TileGridOptions;
@@ -4978,7 +4978,7 @@ olx.tilegrid.TileGridOptions.prototype.tileSizes;
* matrixIds: !Array.<string>, * matrixIds: !Array.<string>,
* tileSize: (number|undefined), * tileSize: (number|undefined),
* tileSizes: (Array.<number>|undefined)}} * tileSizes: (Array.<number>|undefined)}}
* @todo api * @api
*/ */
olx.tilegrid.WMTSOptions; olx.tilegrid.WMTSOptions;
@@ -5027,7 +5027,7 @@ olx.tilegrid.WMTSOptions.prototype.tileSizes;
/** /**
* @typedef {{maxZoom: number}} * @typedef {{maxZoom: number}}
* @todo api * @api
*/ */
olx.tilegrid.XYZOptions; olx.tilegrid.XYZOptions;
@@ -5041,7 +5041,7 @@ olx.tilegrid.XYZOptions.prototype.maxZoom;
/** /**
* @typedef {{resolutions: !Array.<number>}} * @typedef {{resolutions: !Array.<number>}}
* @todo api * @api
*/ */
olx.tilegrid.ZoomifyOptions; olx.tilegrid.ZoomifyOptions;
@@ -5058,7 +5058,7 @@ olx.tilegrid.ZoomifyOptions.prototype.resolutions;
* constrainResolution: (boolean|undefined), * constrainResolution: (boolean|undefined),
* nearest: (boolean|undefined), * nearest: (boolean|undefined),
* minResolution: (number|undefined)}} * minResolution: (number|undefined)}}
* @todo api * @api
*/ */
olx.View.fitGeometryOptions; olx.View.fitGeometryOptions;
@@ -5116,7 +5116,7 @@ olx.View.fitGeometryOptions.prototype.minResolution;
* viewState: olx.ViewState, * viewState: olx.ViewState,
* viewHints: Array.<number>, * viewHints: Array.<number>,
* wantedTiles: Object.<string, Object.<string, boolean>>}} * wantedTiles: Object.<string, Object.<string, boolean>>}}
* @todo api * @api
*/ */
olx.FrameState; olx.FrameState;
@@ -5138,7 +5138,7 @@ olx.FrameState.prototype.viewState;
* projection: ol.proj.Projection, * projection: ol.proj.Projection,
* resolution: number, * resolution: number,
* rotation: number}} * rotation: number}}
* @todo api * @api
*/ */
olx.ViewState; olx.ViewState;

6
externs/readme.md
View File

@@ -32,7 +32,7 @@ ol.MapBrowserEvent = function(type, map, browserEvent, opt_frameState) {
/** /**
* @type {ol.Coordinate} * @type {ol.Coordinate}
* @todo api * @api
*/ */
this.coordinate = map.getEventCoordinate(this.originalEvent); this.coordinate = map.getEventCoordinate(this.originalEvent);
@@ -73,7 +73,7 @@ ol.control.Control = function(options) {
/** /**
* Application subclasses may override this. * Application subclasses may override this.
* @param {ol.Map} map Map. * @param {ol.Map} map Map.
* @todo api * @api
*/ */
ol.control.Control.prototype.setMap = function(map) { ol.control.Control.prototype.setMap = function(map) {
// ... // ...
@@ -88,7 +88,7 @@ Object literals cannot be exported like classes. To make sure that their propert
/** /**
* @typedef {{element: (Element|undefined), * @typedef {{element: (Element|undefined),
* target: (Element|string|undefined)}} * target: (Element|string|undefined)}}
* @todo api * @api
*/ */
olx.control.ControlOptions; olx.control.ControlOptions;

8
src/ol/animation.js
View File

@@ -9,7 +9,7 @@ goog.require('ol.easing');
/** /**
* @param {olx.animation.BounceOptions} options Bounce options. * @param {olx.animation.BounceOptions} options Bounce options.
* @return {ol.PreRenderFunction} Pre-render function. * @return {ol.PreRenderFunction} Pre-render function.
* @todo api * @api
*/ */
ol.animation.bounce = function(options) { ol.animation.bounce = function(options) {
var resolution = options.resolution; var resolution = options.resolution;
@@ -44,7 +44,7 @@ ol.animation.bounce = function(options) {
/** /**
* @param {olx.animation.PanOptions} options Pan options. * @param {olx.animation.PanOptions} options Pan options.
* @return {ol.PreRenderFunction} Pre-render function. * @return {ol.PreRenderFunction} Pre-render function.
* @todo api * @api
*/ */
ol.animation.pan = function(options) { ol.animation.pan = function(options) {
var source = options.source; var source = options.source;
@@ -83,7 +83,7 @@ ol.animation.pan = function(options) {
/** /**
* @param {olx.animation.RotateOptions} options Rotate options. * @param {olx.animation.RotateOptions} options Rotate options.
* @return {ol.PreRenderFunction} Pre-render function. * @return {ol.PreRenderFunction} Pre-render function.
* @todo api * @api
*/ */
ol.animation.rotate = function(options) { ol.animation.rotate = function(options) {
var sourceRotation = goog.isDef(options.rotation) ? options.rotation : 0; var sourceRotation = goog.isDef(options.rotation) ? options.rotation : 0;
@@ -128,7 +128,7 @@ ol.animation.rotate = function(options) {
/** /**
* @param {olx.animation.ZoomOptions} options Zoom options. * @param {olx.animation.ZoomOptions} options Zoom options.
* @return {ol.PreRenderFunction} Pre-render function. * @return {ol.PreRenderFunction} Pre-render function.
* @todo api * @api
*/ */
ol.animation.zoom = function(options) { ol.animation.zoom = function(options) {
var sourceResolution = options.resolution; var sourceResolution = options.resolution;

2
src/ol/attribution.js
View File

@@ -23,7 +23,7 @@ goog.require('ol.TileRange');
* @constructor * @constructor
* @param {olx.AttributionOptions} options Attribution options. * @param {olx.AttributionOptions} options Attribution options.
* @struct * @struct
* @todo api * @api
*/ */
ol.Attribution = function(options) { ol.Attribution = function(options) {

12
src/ol/browserfeature.js
View File

@@ -12,7 +12,7 @@ goog.require('ol.webgl');
* (dips) on the device (`window.devicePixelRatio`). * (dips) on the device (`window.devicePixelRatio`).
* @const * @const
* @type {number} * @type {number}
* @todo api * @api
*/ */
ol.BrowserFeature.DEVICE_PIXEL_RATIO = goog.global.devicePixelRatio || 1; ol.BrowserFeature.DEVICE_PIXEL_RATIO = goog.global.devicePixelRatio || 1;
@@ -36,7 +36,7 @@ ol.BrowserFeature.HAS_CANVAS_LINE_DASH = false;
* True if browser supports Canvas. * True if browser supports Canvas.
* @const * @const
* @type {boolean} * @type {boolean}
* @todo api * @api
*/ */
ol.BrowserFeature.HAS_CANVAS = ol.ENABLE_CANVAS && ( ol.BrowserFeature.HAS_CANVAS = ol.ENABLE_CANVAS && (
/** /**
@@ -66,7 +66,7 @@ ol.BrowserFeature.HAS_CANVAS = ol.ENABLE_CANVAS && (
* Indicates if DeviceOrientation is supported in the user's browser. * Indicates if DeviceOrientation is supported in the user's browser.
* @const * @const
* @type {boolean} * @type {boolean}
* @todo api * @api
*/ */
ol.BrowserFeature.HAS_DEVICE_ORIENTATION = ol.BrowserFeature.HAS_DEVICE_ORIENTATION =
'DeviceOrientationEvent' in goog.global; 'DeviceOrientationEvent' in goog.global;
@@ -84,7 +84,7 @@ ol.BrowserFeature.HAS_DOM = ol.ENABLE_DOM;
* Is HTML5 geolocation supported in the current browser? * Is HTML5 geolocation supported in the current browser?
* @const * @const
* @type {boolean} * @type {boolean}
* @todo api * @api
*/ */
ol.BrowserFeature.HAS_GEOLOCATION = 'geolocation' in goog.global.navigator; ol.BrowserFeature.HAS_GEOLOCATION = 'geolocation' in goog.global.navigator;
@@ -101,7 +101,7 @@ ol.BrowserFeature.HAS_JSON_PARSE =
* True if browser supports touch events. * True if browser supports touch events.
* @const * @const
* @type {boolean} * @type {boolean}
* @todo api * @api
*/ */
ol.BrowserFeature.HAS_TOUCH = ol.ASSUME_TOUCH || 'ontouchstart' in goog.global; ol.BrowserFeature.HAS_TOUCH = ol.ASSUME_TOUCH || 'ontouchstart' in goog.global;
@@ -127,7 +127,7 @@ ol.BrowserFeature.HAS_MSPOINTER =
* True if browser supports WebGL. * True if browser supports WebGL.
* @const * @const
* @type {boolean} * @type {boolean}
* @todo api * @api
*/ */
ol.BrowserFeature.HAS_WEBGL = ol.ENABLE_WEBGL && ( ol.BrowserFeature.HAS_WEBGL = ol.ENABLE_WEBGL && (
/** /**

2
src/ol/canvasfunction.js
View File

@@ -12,6 +12,6 @@ goog.provide('ol.CanvasFunctionType');
* *
* @typedef {function(this:ol.source.ImageCanvas, ol.Extent, number, * @typedef {function(this:ol.source.ImageCanvas, ol.Extent, number,
* number, ol.Size, ol.proj.Projection): HTMLCanvasElement} * number, ol.Size, ol.proj.Projection): HTMLCanvasElement}
* @todo api * @api
*/ */
ol.CanvasFunctionType; ol.CanvasFunctionType;

2
src/ol/centerconstraint.js
View File

@@ -6,7 +6,7 @@ goog.require('goog.math');
/** /**
* @typedef {function((ol.Coordinate|undefined)): (ol.Coordinate|undefined)} * @typedef {function((ol.Coordinate|undefined)): (ol.Coordinate|undefined)}
* @todo api * @api
*/ */
ol.CenterConstraintType; ol.CenterConstraintType;

32
src/ol/collection.js
View File

@@ -19,13 +19,13 @@ ol.CollectionEventType = {
/** /**
* Triggered when an item is added to the collection. * Triggered when an item is added to the collection.
* @event ol.CollectionEvent#add * @event ol.CollectionEvent#add
* @todo api stable * @api stable
*/ */
ADD: 'add', ADD: 'add',
/** /**
* Triggered when an item is removed from the collection. * Triggered when an item is removed from the collection.
* @event ol.CollectionEvent#remove * @event ol.CollectionEvent#remove
* @todo api stable * @api stable
*/ */
REMOVE: 'remove' REMOVE: 'remove'
}; };
@@ -47,7 +47,7 @@ ol.CollectionEvent = function(type, opt_element, opt_target) {
/** /**
* The element that is added to or removed from the collection. * The element that is added to or removed from the collection.
* @type {*} * @type {*}
* @todo api stable * @api stable
*/ */
this.element = opt_element; this.element = opt_element;
@@ -75,7 +75,7 @@ ol.CollectionProperty = {
* @extends {ol.Object} * @extends {ol.Object}
* @fires ol.CollectionEvent * @fires ol.CollectionEvent
* @param {Array=} opt_array Array. * @param {Array=} opt_array Array.
* @todo api stable * @api stable
*/ */
ol.Collection = function(opt_array) { ol.Collection = function(opt_array) {
@@ -95,7 +95,7 @@ goog.inherits(ol.Collection, ol.Object);
/** /**
* Remove all elements from the collection. * Remove all elements from the collection.
* @todo api stable * @api stable
*/ */
ol.Collection.prototype.clear = function() { ol.Collection.prototype.clear = function() {
while (this.getLength() > 0) { while (this.getLength() > 0) {
@@ -107,7 +107,7 @@ ol.Collection.prototype.clear = function() {
/** /**
* @param {Array} arr Array. * @param {Array} arr Array.
* @return {ol.Collection} This collection. * @return {ol.Collection} This collection.
* @todo api stable * @api stable
*/ */
ol.Collection.prototype.extend = function(arr) { ol.Collection.prototype.extend = function(arr) {
var i, ii; var i, ii;
@@ -125,7 +125,7 @@ ol.Collection.prototype.extend = function(arr) {
* index and the array). The return value is ignored. * index and the array). The return value is ignored.
* @param {S=} opt_this The object to use as `this` in `f`. * @param {S=} opt_this The object to use as `this` in `f`.
* @template T,S * @template T,S
* @todo api stable * @api stable
*/ */
ol.Collection.prototype.forEach = function(f, opt_this) { ol.Collection.prototype.forEach = function(f, opt_this) {
goog.array.forEach(this.array_, f, opt_this); goog.array.forEach(this.array_, f, opt_this);
@@ -138,7 +138,7 @@ ol.Collection.prototype.forEach = function(f, opt_this) {
* collection's "length" property won't be in sync with the actual length * collection's "length" property won't be in sync with the actual length
* of the array. * of the array.
* @return {Array} Array. * @return {Array} Array.
* @todo api stable * @api stable
*/ */
ol.Collection.prototype.getArray = function() { ol.Collection.prototype.getArray = function() {
return this.array_; return this.array_;
@@ -149,7 +149,7 @@ ol.Collection.prototype.getArray = function() {
* Get the element at the provided index. * Get the element at the provided index.
* @param {number} index Index. * @param {number} index Index.
* @return {*} Element. * @return {*} Element.
* @todo api stable * @api stable
*/ */
ol.Collection.prototype.item = function(index) { ol.Collection.prototype.item = function(index) {
return this.array_[index]; return this.array_[index];
@@ -160,7 +160,7 @@ ol.Collection.prototype.item = function(index) {
* Get the length of this collection. * Get the length of this collection.
* @return {number} The length of the array. * @return {number} The length of the array.
* @todo observable * @todo observable
* @todo api stable * @api stable
*/ */
ol.Collection.prototype.getLength = function() { ol.Collection.prototype.getLength = function() {
return /** @type {number} */ (this.get(ol.CollectionProperty.LENGTH)); return /** @type {number} */ (this.get(ol.CollectionProperty.LENGTH));
@@ -171,7 +171,7 @@ ol.Collection.prototype.getLength = function() {
* Insert an element at the provided index. * Insert an element at the provided index.
* @param {number} index Index. * @param {number} index Index.
* @param {*} elem Element. * @param {*} elem Element.
* @todo api stable * @api stable
*/ */
ol.Collection.prototype.insertAt = function(index, elem) { ol.Collection.prototype.insertAt = function(index, elem) {
goog.array.insertAt(this.array_, elem, index); goog.array.insertAt(this.array_, elem, index);
@@ -184,7 +184,7 @@ ol.Collection.prototype.insertAt = function(index, elem) {
/** /**
* Remove the last element of the collection. * Remove the last element of the collection.
* @return {*} Element. * @return {*} Element.
* @todo api stable * @api stable
*/ */
ol.Collection.prototype.pop = function() { ol.Collection.prototype.pop = function() {
return this.removeAt(this.getLength() - 1); return this.removeAt(this.getLength() - 1);
@@ -195,7 +195,7 @@ ol.Collection.prototype.pop = function() {
* Insert the provided element at the end of the collection. * Insert the provided element at the end of the collection.
* @param {*} elem Element. * @param {*} elem Element.
* @return {number} Length. * @return {number} Length.
* @todo api stable * @api stable
*/ */
ol.Collection.prototype.push = function(elem) { ol.Collection.prototype.push = function(elem) {
var n = this.array_.length; var n = this.array_.length;
@@ -208,7 +208,7 @@ ol.Collection.prototype.push = function(elem) {
* Removes the first occurence of elem from the collection. * Removes the first occurence of elem from the collection.
* @param {*} elem Element. * @param {*} elem Element.
* @return {*} The removed element or undefined if elem was not found. * @return {*} The removed element or undefined if elem was not found.
* @todo api stable * @api stable
*/ */
ol.Collection.prototype.remove = function(elem) { ol.Collection.prototype.remove = function(elem) {
var arr = this.array_; var arr = this.array_;
@@ -226,7 +226,7 @@ ol.Collection.prototype.remove = function(elem) {
* Remove the element at the provided index. * Remove the element at the provided index.
* @param {number} index Index. * @param {number} index Index.
* @return {*} Value. * @return {*} Value.
* @todo api stable * @api stable
*/ */
ol.Collection.prototype.removeAt = function(index) { ol.Collection.prototype.removeAt = function(index) {
var prev = this.array_[index]; var prev = this.array_[index];
@@ -242,7 +242,7 @@ ol.Collection.prototype.removeAt = function(index) {
* Set the element at the provided index. * Set the element at the provided index.
* @param {number} index Index. * @param {number} index Index.
* @param {*} elem Element. * @param {*} elem Element.
* @todo api stable * @api stable
*/ */
ol.Collection.prototype.setAt = function(index, elem) { ol.Collection.prototype.setAt = function(index, elem) {
var n = this.getLength(); var n = this.getLength();

4
src/ol/color/color.js
View File

@@ -95,7 +95,7 @@ ol.color.blend = function(dst, src, opt_color) {
/** /**
* @param {ol.Color|string} color Color. * @param {ol.Color|string} color Color.
* @return {ol.Color} Color. * @return {ol.Color} Color.
* @todo api * @api
*/ */
ol.color.asArray = function(color) { ol.color.asArray = function(color) {
if (goog.isArray(color)) { if (goog.isArray(color)) {
@@ -110,7 +110,7 @@ ol.color.asArray = function(color) {
/** /**
* @param {ol.Color|string} color Color. * @param {ol.Color|string} color Color.
* @return {string} String. * @return {string} String.
* @todo api * @api
*/ */
ol.color.asString = function(color) { ol.color.asString = function(color) {
if (goog.isString(color)) { if (goog.isString(color)) {

2
src/ol/control/attributioncontrol.js
View File

@@ -22,7 +22,7 @@ goog.require('ol.css');
* @constructor * @constructor
* @extends {ol.control.Control} * @extends {ol.control.Control}
* @param {olx.control.AttributionOptions=} opt_options Attribution options. * @param {olx.control.AttributionOptions=} opt_options Attribution options.
* @todo api * @api
*/ */
ol.control.Attribution = function(opt_options) { ol.control.Attribution = function(opt_options) {

6
src/ol/control/control.js
View File

@@ -34,7 +34,7 @@ goog.require('ol.Object');
* @extends {ol.Object} * @extends {ol.Object}
* @implements {oli.control.Control} * @implements {oli.control.Control}
* @param {olx.control.ControlOptions} options Control options. * @param {olx.control.ControlOptions} options Control options.
* @todo api stable * @api stable
*/ */
ol.control.Control = function(options) { ol.control.Control = function(options) {
@@ -81,7 +81,7 @@ ol.control.Control.prototype.disposeInternal = function() {
/** /**
* Get the map associated with this control. * Get the map associated with this control.
* @return {ol.Map} Map. * @return {ol.Map} Map.
* @todo api * @api
*/ */
ol.control.Control.prototype.getMap = function() { ol.control.Control.prototype.getMap = function() {
return this.map_; return this.map_;
@@ -102,7 +102,7 @@ ol.control.Control.prototype.handleMapPostrender = goog.nullFunction;
* Subclasses may set up event handlers to get notified about changes to * Subclasses may set up event handlers to get notified about changes to
* the map here. * the map here.
* @param {ol.Map} map Map. * @param {ol.Map} map Map.
* @todo api stable * @api stable
*/ */
ol.control.Control.prototype.setMap = function(map) { ol.control.Control.prototype.setMap = function(map) {
if (!goog.isNull(this.map_)) { if (!goog.isNull(this.map_)) {

2
src/ol/control/controldefaults.js
View File

@@ -19,7 +19,7 @@ goog.require('ol.control.Zoom');
* *
* @param {olx.control.DefaultsOptions=} opt_options Defaults options. * @param {olx.control.DefaultsOptions=} opt_options Defaults options.
* @return {ol.Collection} Controls. * @return {ol.Collection} Controls.
* @todo api * @api
*/ */
ol.control.defaults = function(opt_options) { ol.control.defaults = function(opt_options) {

2
src/ol/control/fullscreencontrol.js
View File

@@ -25,7 +25,7 @@ goog.require('ol.pointer.PointerEventHandler');
* @constructor * @constructor
* @extends {ol.control.Control} * @extends {ol.control.Control}
* @param {olx.control.FullScreenOptions=} opt_options Options. * @param {olx.control.FullScreenOptions=} opt_options Options.
* @todo api * @api
*/ */
ol.control.FullScreen = function(opt_options) { ol.control.FullScreen = function(opt_options) {

2
src/ol/control/logocontrol.js
View File

@@ -19,7 +19,7 @@ goog.require('ol.css');
* @constructor * @constructor
* @extends {ol.control.Control} * @extends {ol.control.Control}
* @param {olx.control.LogoOptions=} opt_options Logo options. * @param {olx.control.LogoOptions=} opt_options Logo options.
* @todo api * @api
*/ */
ol.control.Logo = function(opt_options) { ol.control.Logo = function(opt_options) {

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

@@ -37,7 +37,7 @@ ol.control.MousePositionProperty = {
* @extends {ol.control.Control} * @extends {ol.control.Control}
* @param {olx.control.MousePositionOptions=} opt_options Mouse position * @param {olx.control.MousePositionOptions=} opt_options Mouse position
* options. * options.
* @todo api * @api
*/ */
ol.control.MousePosition = function(opt_options) { ol.control.MousePosition = function(opt_options) {
@@ -130,7 +130,7 @@ ol.control.MousePosition.prototype.handleProjectionChanged_ = function() {
* @return {ol.CoordinateFormatType|undefined} The format to render the current * @return {ol.CoordinateFormatType|undefined} The format to render the current
* position in. * position in.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.control.MousePosition.prototype.getCoordinateFormat = function() { ol.control.MousePosition.prototype.getCoordinateFormat = function() {
return /** @type {ol.CoordinateFormatType|undefined} */ ( return /** @type {ol.CoordinateFormatType|undefined} */ (
@@ -146,7 +146,7 @@ goog.exportProperty(
* @return {ol.proj.Projection|undefined} The projection to report mouse * @return {ol.proj.Projection|undefined} The projection to report mouse
* position in. * position in.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.control.MousePosition.prototype.getProjection = function() { ol.control.MousePosition.prototype.getProjection = function() {
return /** @type {ol.proj.Projection|undefined} */ ( return /** @type {ol.proj.Projection|undefined} */ (
@@ -183,7 +183,7 @@ ol.control.MousePosition.prototype.handleMouseOut = function(browserEvent) {
/** /**
* @inheritDoc * @inheritDoc
* @todo api * @api
*/ */
ol.control.MousePosition.prototype.setMap = function(map) { ol.control.MousePosition.prototype.setMap = function(map) {
goog.base(this, 'setMap', map); goog.base(this, 'setMap', map);
@@ -203,7 +203,7 @@ ol.control.MousePosition.prototype.setMap = function(map) {
* @param {ol.CoordinateFormatType} format The format to render the current * @param {ol.CoordinateFormatType} format The format to render the current
* position in. * position in.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.control.MousePosition.prototype.setCoordinateFormat = function(format) { ol.control.MousePosition.prototype.setCoordinateFormat = function(format) {
this.set(ol.control.MousePositionProperty.COORDINATE_FORMAT, format); this.set(ol.control.MousePositionProperty.COORDINATE_FORMAT, format);
@@ -218,7 +218,7 @@ goog.exportProperty(
* @param {ol.proj.Projection} projection The projection to report mouse * @param {ol.proj.Projection} projection The projection to report mouse
* position in. * position in.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.control.MousePosition.prototype.setProjection = function(projection) { ol.control.MousePosition.prototype.setProjection = function(projection) {
this.set(ol.control.MousePositionProperty.PROJECTION, projection); this.set(ol.control.MousePositionProperty.PROJECTION, projection);

2
src/ol/control/rotatecontrol.js
View File

@@ -21,7 +21,7 @@ goog.require('ol.pointer.PointerEventHandler');
* @constructor * @constructor
* @extends {ol.control.Control} * @extends {ol.control.Control}
* @param {olx.control.RotateOptions=} opt_options Rotate options. * @param {olx.control.RotateOptions=} opt_options Rotate options.
* @todo api * @api
*/ */
ol.control.Rotate = function(opt_options) { ol.control.Rotate = function(opt_options) {

8
src/ol/control/scalelinecontrol.js
View File

@@ -29,7 +29,7 @@ ol.control.ScaleLineProperty = {
* Units for the scale line. Supported values are `'degrees'`, `'imperial'`, * Units for the scale line. Supported values are `'degrees'`, `'imperial'`,
* `'nautical'`, `'metric'`, `'us'`. * `'nautical'`, `'metric'`, `'us'`.
* @enum {string} * @enum {string}
* @todo api * @api
*/ */
ol.control.ScaleLineUnits = { ol.control.ScaleLineUnits = {
DEGREES: 'degrees', DEGREES: 'degrees',
@@ -50,7 +50,7 @@ ol.control.ScaleLineUnits = {
* @constructor * @constructor
* @extends {ol.control.Control} * @extends {ol.control.Control}
* @param {olx.control.ScaleLineOptions=} opt_options Scale line options. * @param {olx.control.ScaleLineOptions=} opt_options Scale line options.
* @todo api * @api
*/ */
ol.control.ScaleLine = function(opt_options) { ol.control.ScaleLine = function(opt_options) {
@@ -138,7 +138,7 @@ ol.control.ScaleLine.LEADING_DIGITS = [1, 2, 5];
* @return {ol.control.ScaleLineUnits|undefined} The units to use in the scale * @return {ol.control.ScaleLineUnits|undefined} The units to use in the scale
* line. * line.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.control.ScaleLine.prototype.getUnits = function() { ol.control.ScaleLine.prototype.getUnits = function() {
return /** @type {ol.control.ScaleLineUnits|undefined} */ ( return /** @type {ol.control.ScaleLineUnits|undefined} */ (
@@ -175,7 +175,7 @@ ol.control.ScaleLine.prototype.handleUnitsChanged_ = function() {
/** /**
* @param {ol.control.ScaleLineUnits} units The units to use in the scale line. * @param {ol.control.ScaleLineUnits} units The units to use in the scale line.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.control.ScaleLine.prototype.setUnits = function(units) { ol.control.ScaleLine.prototype.setUnits = function(units) {
this.set(ol.control.ScaleLineProperty.UNITS, units); this.set(ol.control.ScaleLineProperty.UNITS, units);

2
src/ol/control/zoomcontrol.js
View File

@@ -22,7 +22,7 @@ goog.require('ol.pointer.PointerEventHandler');
* @constructor * @constructor
* @extends {ol.control.Control} * @extends {ol.control.Control}
* @param {olx.control.ZoomOptions=} opt_options Zoom options. * @param {olx.control.ZoomOptions=} opt_options Zoom options.
* @todo api * @api
*/ */
ol.control.Zoom = function(opt_options) { ol.control.Zoom = function(opt_options) {

2
src/ol/control/zoomslidercontrol.js
View File

@@ -32,7 +32,7 @@ goog.require('ol.easing');
* @constructor * @constructor
* @extends {ol.control.Control} * @extends {ol.control.Control}
* @param {olx.control.ZoomSliderOptions=} opt_options Zoom slider options. * @param {olx.control.ZoomSliderOptions=} opt_options Zoom slider options.
* @todo api * @api
*/ */
ol.control.ZoomSlider = function(opt_options) { ol.control.ZoomSlider = function(opt_options) {

2
src/ol/control/zoomtoextentcontrol.js
View File

@@ -19,7 +19,7 @@ goog.require('ol.pointer.PointerEventHandler');
* @constructor * @constructor
* @extends {ol.control.Control} * @extends {ol.control.Control}
* @param {olx.control.ZoomToExtentOptions=} opt_options Options. * @param {olx.control.ZoomToExtentOptions=} opt_options Options.
* @todo api * @api
*/ */
ol.control.ZoomToExtent = function(opt_options) { ol.control.ZoomToExtent = function(opt_options) {
var options = goog.isDef(opt_options) ? opt_options : {}; var options = goog.isDef(opt_options) ? opt_options : {};

20
src/ol/coordinate.js
View File

@@ -11,7 +11,7 @@ goog.require('goog.math');
* `{string}`. * `{string}`.
* *
* @typedef {function((ol.Coordinate|undefined)): string} * @typedef {function((ol.Coordinate|undefined)): string}
* @todo api * @api
*/ */
ol.CoordinateFormatType; ol.CoordinateFormatType;
@@ -19,7 +19,7 @@ ol.CoordinateFormatType;
/** /**
* An array of numbers representing an xy coordinate. Example: `[16, 48]`. * An array of numbers representing an xy coordinate. Example: `[16, 48]`.
* @typedef {Array.<number>} ol.Coordinate * @typedef {Array.<number>} ol.Coordinate
* @todo api * @api
*/ */
ol.Coordinate; ol.Coordinate;
@@ -27,7 +27,7 @@ ol.Coordinate;
/** /**
* An array of coordinate arrays. * An array of coordinate arrays.
* @typedef {Array.<ol.Coordinate>} * @typedef {Array.<ol.Coordinate>}
* @todo api * @api
*/ */
ol.CoordinateArray; ol.CoordinateArray;
@@ -39,7 +39,7 @@ ol.CoordinateArray;
* @param {ol.Coordinate} coordinate Coordinate. * @param {ol.Coordinate} coordinate Coordinate.
* @param {ol.Coordinate} delta Delta. * @param {ol.Coordinate} delta Delta.
* @return {ol.Coordinate} Coordinate. * @return {ol.Coordinate} Coordinate.
* @todo api * @api
*/ */
ol.coordinate.add = function(coordinate, delta) { ol.coordinate.add = function(coordinate, delta) {
coordinate[0] += delta[0]; coordinate[0] += delta[0];
@@ -91,7 +91,7 @@ ol.coordinate.closestOnSegment = function(coordinate, segment) {
* @param {number=} opt_fractionDigits The number of digits to include * @param {number=} opt_fractionDigits The number of digits to include
* after the decimal point. Default is `0`. * after the decimal point. Default is `0`.
* @return {ol.CoordinateFormatType} Coordinate format. * @return {ol.CoordinateFormatType} Coordinate format.
* @todo api * @api
*/ */
ol.coordinate.createStringXY = function(opt_fractionDigits) { ol.coordinate.createStringXY = function(opt_fractionDigits) {
return ( return (
@@ -128,7 +128,7 @@ ol.coordinate.degreesToStringHDMS_ = function(degrees, hemispheres) {
* @param {number=} opt_fractionDigits The number of digits to include * @param {number=} opt_fractionDigits The number of digits to include
* after the decimal point. Default is `0`. * after the decimal point. Default is `0`.
* @return {string} Formated coordinate. * @return {string} Formated coordinate.
* @todo api * @api
*/ */
ol.coordinate.format = function(coordinate, template, opt_fractionDigits) { ol.coordinate.format = function(coordinate, template, opt_fractionDigits) {
if (goog.isDef(coordinate)) { if (goog.isDef(coordinate)) {
@@ -165,7 +165,7 @@ ol.coordinate.equals = function(coordinate1, coordinate2) {
* @param {ol.Coordinate} coordinate Coordinate. * @param {ol.Coordinate} coordinate Coordinate.
* @param {number} angle Angle in radian. * @param {number} angle Angle in radian.
* @return {ol.Coordinate} Coordinate. * @return {ol.Coordinate} Coordinate.
* @todo api * @api
*/ */
ol.coordinate.rotate = function(coordinate, angle) { ol.coordinate.rotate = function(coordinate, angle) {
var cosAngle = Math.cos(angle); var cosAngle = Math.cos(angle);
@@ -236,7 +236,7 @@ ol.coordinate.squaredDistanceToSegment = function(coordinate, segment) {
/** /**
* @param {ol.Coordinate|undefined} coordinate Coordinate. * @param {ol.Coordinate|undefined} coordinate Coordinate.
* @return {string} Hemisphere, degrees, minutes and seconds. * @return {string} Hemisphere, degrees, minutes and seconds.
* @todo api * @api
*/ */
ol.coordinate.toStringHDMS = function(coordinate) { ol.coordinate.toStringHDMS = function(coordinate) {
if (goog.isDef(coordinate)) { if (goog.isDef(coordinate)) {
@@ -253,7 +253,7 @@ ol.coordinate.toStringHDMS = function(coordinate) {
* @param {number=} opt_fractionDigits The number of digits to include * @param {number=} opt_fractionDigits The number of digits to include
* after the decimal point. Default is `0`. * after the decimal point. Default is `0`.
* @return {string} XY. * @return {string} XY.
* @todo api * @api
*/ */
ol.coordinate.toStringXY = function(coordinate, opt_fractionDigits) { ol.coordinate.toStringXY = function(coordinate, opt_fractionDigits) {
return ol.coordinate.format(coordinate, '{x}, {y}', opt_fractionDigits); return ol.coordinate.format(coordinate, '{x}, {y}', opt_fractionDigits);
@@ -265,7 +265,7 @@ ol.coordinate.toStringXY = function(coordinate, opt_fractionDigits) {
* @param {Array} array The array with coordinates. * @param {Array} array The array with coordinates.
* @param {string} axis the axis info. * @param {string} axis the axis info.
* @return {ol.Coordinate} The coordinate created. * @return {ol.Coordinate} The coordinate created.
* @todo api * @api
*/ */
ol.coordinate.fromProjectedArray = function(array, axis) { ol.coordinate.fromProjectedArray = function(array, axis) {
var firstAxis = axis.charAt(0); var firstAxis = axis.charAt(0);

14
src/ol/deviceorientation.js
View File

@@ -71,7 +71,7 @@ ol.DeviceOrientationProperty = {
* @extends {ol.Object} * @extends {ol.Object}
* @fires change Triggered when the device orientation changes. * @fires change Triggered when the device orientation changes.
* @param {olx.DeviceOrientationOptions=} opt_options Options. * @param {olx.DeviceOrientationOptions=} opt_options Options.
* @todo api * @api
*/ */
ol.DeviceOrientation = function(opt_options) { ol.DeviceOrientation = function(opt_options) {
@@ -140,7 +140,7 @@ ol.DeviceOrientation.prototype.orientationChange_ = function(browserEvent) {
* @return {number|undefined} The euler angle in radians of the device from the * @return {number|undefined} The euler angle in radians of the device from the
* standard Z axis. * standard Z axis.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.DeviceOrientation.prototype.getAlpha = function() { ol.DeviceOrientation.prototype.getAlpha = function() {
return /** @type {number|undefined} */ ( return /** @type {number|undefined} */ (
@@ -156,7 +156,7 @@ goog.exportProperty(
* @return {number|undefined} The euler angle in radians of the device from the * @return {number|undefined} The euler angle in radians of the device from the
* planar X axis. * planar X axis.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.DeviceOrientation.prototype.getBeta = function() { ol.DeviceOrientation.prototype.getBeta = function() {
return /** @type {number|undefined} */ ( return /** @type {number|undefined} */ (
@@ -172,7 +172,7 @@ goog.exportProperty(
* @return {number|undefined} The euler angle in radians of the device from the * @return {number|undefined} The euler angle in radians of the device from the
* planar Y axis. * planar Y axis.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.DeviceOrientation.prototype.getGamma = function() { ol.DeviceOrientation.prototype.getGamma = function() {
return /** @type {number|undefined} */ ( return /** @type {number|undefined} */ (
@@ -188,7 +188,7 @@ goog.exportProperty(
* @return {number|undefined} The heading of the device relative to north, in * @return {number|undefined} The heading of the device relative to north, in
* radians, normalizing for different browser behavior. * radians, normalizing for different browser behavior.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.DeviceOrientation.prototype.getHeading = function() { ol.DeviceOrientation.prototype.getHeading = function() {
return /** @type {number|undefined} */ ( return /** @type {number|undefined} */ (
@@ -205,7 +205,7 @@ goog.exportProperty(
* @return {boolean} The status of tracking changes to alpha, beta and gamma. * @return {boolean} The status of tracking changes to alpha, beta and gamma.
* If true, changes are tracked and reported immediately. * If true, changes are tracked and reported immediately.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.DeviceOrientation.prototype.getTracking = function() { ol.DeviceOrientation.prototype.getTracking = function() {
return /** @type {boolean} */ ( return /** @type {boolean} */ (
@@ -239,7 +239,7 @@ ol.DeviceOrientation.prototype.handleTrackingChanged_ = function() {
* @param {boolean} tracking The status of tracking changes to alpha, beta and * @param {boolean} tracking The status of tracking changes to alpha, beta and
* gamma. If true, changes are tracked and reported immediately. * gamma. If true, changes are tracked and reported immediately.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.DeviceOrientation.prototype.setTracking = function(tracking) { ol.DeviceOrientation.prototype.setTracking = function(tracking) {
this.set(ol.DeviceOrientationProperty.TRACKING, tracking); this.set(ol.DeviceOrientationProperty.TRACKING, tracking);

10
src/ol/dom/input.js
View File

@@ -30,7 +30,7 @@ ol.dom.InputProperty = {
* @constructor * @constructor
* @extends {ol.Object} * @extends {ol.Object}
* @param {Element} target Target element. * @param {Element} target Target element.
* @todo api * @api
*/ */
ol.dom.Input = function(target) { ol.dom.Input = function(target) {
goog.base(this); goog.base(this);
@@ -59,7 +59,7 @@ goog.inherits(ol.dom.Input, ol.Object);
* If the input is a checkbox, return whether or not the checkbox is checked. * If the input is a checkbox, return whether or not the checkbox is checked.
* @return {boolean|undefined} The checked state of the Input. * @return {boolean|undefined} The checked state of the Input.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.dom.Input.prototype.getChecked = function() { ol.dom.Input.prototype.getChecked = function() {
return /** @type {boolean} */ (this.get(ol.dom.InputProperty.CHECKED)); return /** @type {boolean} */ (this.get(ol.dom.InputProperty.CHECKED));
@@ -74,7 +74,7 @@ goog.exportProperty(
* Get the value of the input. * Get the value of the input.
* @return {string|undefined} The value of the Input. * @return {string|undefined} The value of the Input.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.dom.Input.prototype.getValue = function() { ol.dom.Input.prototype.getValue = function() {
return /** @type {string} */ (this.get(ol.dom.InputProperty.VALUE)); return /** @type {string} */ (this.get(ol.dom.InputProperty.VALUE));
@@ -89,7 +89,7 @@ goog.exportProperty(
* Sets the value of the input. * Sets the value of the input.
* @param {string} value The value of the Input. * @param {string} value The value of the Input.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.dom.Input.prototype.setValue = function(value) { ol.dom.Input.prototype.setValue = function(value) {
this.set(ol.dom.InputProperty.VALUE, value); this.set(ol.dom.InputProperty.VALUE, value);
@@ -104,7 +104,7 @@ goog.exportProperty(
* Set whether or not a checkbox is checked. * Set whether or not a checkbox is checked.
* @param {boolean} checked The checked state of the Input. * @param {boolean} checked The checked state of the Input.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.dom.Input.prototype.setChecked = function(checked) { ol.dom.Input.prototype.setChecked = function(checked) {
this.set(ol.dom.InputProperty.CHECKED, checked); this.set(ol.dom.InputProperty.CHECKED, checked);

10
src/ol/easing.js
View File

@@ -7,7 +7,7 @@ goog.require('goog.fx.easing');
* @function * @function
* @param {number} t Input between 0 and 1. * @param {number} t Input between 0 and 1.
* @return {number} Output between 0 and 1. * @return {number} Output between 0 and 1.
* @todo api * @api
*/ */
ol.easing.easeIn = goog.fx.easing.easeIn; ol.easing.easeIn = goog.fx.easing.easeIn;
@@ -16,7 +16,7 @@ ol.easing.easeIn = goog.fx.easing.easeIn;
* @function * @function
* @param {number} t Input between 0 and 1. * @param {number} t Input between 0 and 1.
* @return {number} Output between 0 and 1. * @return {number} Output between 0 and 1.
* @todo api * @api
*/ */
ol.easing.easeOut = goog.fx.easing.easeOut; ol.easing.easeOut = goog.fx.easing.easeOut;
@@ -25,7 +25,7 @@ ol.easing.easeOut = goog.fx.easing.easeOut;
* @function * @function
* @param {number} t Input between 0 and 1. * @param {number} t Input between 0 and 1.
* @return {number} Output between 0 and 1. * @return {number} Output between 0 and 1.
* @todo api * @api
*/ */
ol.easing.inAndOut = goog.fx.easing.inAndOut; ol.easing.inAndOut = goog.fx.easing.inAndOut;
@@ -33,7 +33,7 @@ ol.easing.inAndOut = goog.fx.easing.inAndOut;
/** /**
* @param {number} t Input between 0 and 1. * @param {number} t Input between 0 and 1.
* @return {number} Output between 0 and 1. * @return {number} Output between 0 and 1.
* @todo api * @api
*/ */
ol.easing.linear = function(t) { ol.easing.linear = function(t) {
return t; return t;
@@ -43,7 +43,7 @@ ol.easing.linear = function(t) {
/** /**
* @param {number} t Input between 0 and 1. * @param {number} t Input between 0 and 1.
* @return {number} Output between 0 and 1. * @return {number} Output between 0 and 1.
* @todo api * @api
*/ */
ol.easing.upAndDown = function(t) { ol.easing.upAndDown = function(t) {
if (t < 0.5) { if (t < 0.5) {

26
src/ol/events/condition.js
View File

@@ -13,7 +13,7 @@ goog.require('ol.MapBrowserPointerEvent');
* `{boolean}`. If the condition is met, true should be returned. * `{boolean}`. If the condition is met, true should be returned.
* *
* @typedef {function(ol.MapBrowserEvent): boolean} * @typedef {function(ol.MapBrowserEvent): boolean}
* @todo api * @api
*/ */
ol.events.ConditionType; ol.events.ConditionType;
@@ -21,7 +21,7 @@ ol.events.ConditionType;
/** /**
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} True if only the alt key is pressed. * @return {boolean} True if only the alt key is pressed.
* @todo api * @api
*/ */
ol.events.condition.altKeyOnly = function(mapBrowserEvent) { ol.events.condition.altKeyOnly = function(mapBrowserEvent) {
var browserEvent = mapBrowserEvent.browserEvent; var browserEvent = mapBrowserEvent.browserEvent;
@@ -35,7 +35,7 @@ ol.events.condition.altKeyOnly = function(mapBrowserEvent) {
/** /**
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} True if only the alt and shift keys are pressed. * @return {boolean} True if only the alt and shift keys are pressed.
* @todo api * @api
*/ */
ol.events.condition.altShiftKeysOnly = function(mapBrowserEvent) { ol.events.condition.altShiftKeysOnly = function(mapBrowserEvent) {
var browserEvent = mapBrowserEvent.browserEvent; var browserEvent = mapBrowserEvent.browserEvent;
@@ -50,7 +50,7 @@ ol.events.condition.altShiftKeysOnly = function(mapBrowserEvent) {
* Always true. * Always true.
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} True. * @return {boolean} True.
* @todo api * @api
*/ */
ol.events.condition.always = goog.functions.TRUE; ol.events.condition.always = goog.functions.TRUE;
@@ -58,7 +58,7 @@ ol.events.condition.always = goog.functions.TRUE;
/** /**
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} True if the event is a map `click` event. * @return {boolean} True if the event is a map `click` event.
* @todo api * @api
*/ */
ol.events.condition.click = function(mapBrowserEvent) { ol.events.condition.click = function(mapBrowserEvent) {
return mapBrowserEvent.type == ol.MapBrowserEvent.EventType.CLICK; return mapBrowserEvent.type == ol.MapBrowserEvent.EventType.CLICK;
@@ -68,7 +68,7 @@ ol.events.condition.click = function(mapBrowserEvent) {
/** /**
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} True if the browser event is a `mousemove` event. * @return {boolean} True if the browser event is a `mousemove` event.
* @todo api * @api
*/ */
ol.events.condition.mouseMove = function(mapBrowserEvent) { ol.events.condition.mouseMove = function(mapBrowserEvent) {
return mapBrowserEvent.originalEvent.type == 'mousemove'; return mapBrowserEvent.originalEvent.type == 'mousemove';
@@ -79,7 +79,7 @@ ol.events.condition.mouseMove = function(mapBrowserEvent) {
* Always false. * Always false.
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} False. * @return {boolean} False.
* @todo api * @api
*/ */
ol.events.condition.never = goog.functions.FALSE; ol.events.condition.never = goog.functions.FALSE;
@@ -87,7 +87,7 @@ ol.events.condition.never = goog.functions.FALSE;
/** /**
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} True if the event is a map `singleclick` event. * @return {boolean} True if the event is a map `singleclick` event.
* @todo api * @api
*/ */
ol.events.condition.singleClick = function(mapBrowserEvent) { ol.events.condition.singleClick = function(mapBrowserEvent) {
return mapBrowserEvent.type == ol.MapBrowserEvent.EventType.SINGLECLICK; return mapBrowserEvent.type == ol.MapBrowserEvent.EventType.SINGLECLICK;
@@ -97,7 +97,7 @@ ol.events.condition.singleClick = function(mapBrowserEvent) {
/** /**
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} True only if there no modifier keys are pressed. * @return {boolean} True only if there no modifier keys are pressed.
* @todo api * @api
*/ */
ol.events.condition.noModifierKeys = function(mapBrowserEvent) { ol.events.condition.noModifierKeys = function(mapBrowserEvent) {
var browserEvent = mapBrowserEvent.browserEvent; var browserEvent = mapBrowserEvent.browserEvent;
@@ -111,7 +111,7 @@ ol.events.condition.noModifierKeys = function(mapBrowserEvent) {
/** /**
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} True if only the platform modifier key is pressed. * @return {boolean} True if only the platform modifier key is pressed.
* @todo api * @api
*/ */
ol.events.condition.platformModifierKeyOnly = function(mapBrowserEvent) { ol.events.condition.platformModifierKeyOnly = function(mapBrowserEvent) {
var browserEvent = mapBrowserEvent.browserEvent; var browserEvent = mapBrowserEvent.browserEvent;
@@ -125,7 +125,7 @@ ol.events.condition.platformModifierKeyOnly = function(mapBrowserEvent) {
/** /**
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} True if only the shift key is pressed. * @return {boolean} True if only the shift key is pressed.
* @todo api * @api
*/ */
ol.events.condition.shiftKeyOnly = function(mapBrowserEvent) { ol.events.condition.shiftKeyOnly = function(mapBrowserEvent) {
var browserEvent = mapBrowserEvent.browserEvent; var browserEvent = mapBrowserEvent.browserEvent;
@@ -139,7 +139,7 @@ ol.events.condition.shiftKeyOnly = function(mapBrowserEvent) {
/** /**
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} True only if the target element is not editable. * @return {boolean} True only if the target element is not editable.
* @todo api * @api
*/ */
ol.events.condition.targetNotEditable = function(mapBrowserEvent) { ol.events.condition.targetNotEditable = function(mapBrowserEvent) {
var target = mapBrowserEvent.browserEvent.target; var target = mapBrowserEvent.browserEvent.target;
@@ -155,7 +155,7 @@ ol.events.condition.targetNotEditable = function(mapBrowserEvent) {
/** /**
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} True if the event originates from a mouse device. * @return {boolean} True if the event originates from a mouse device.
* @todo api * @api
*/ */
ol.events.condition.mouseOnly = function(mapBrowserEvent) { ol.events.condition.mouseOnly = function(mapBrowserEvent) {
goog.asserts.assertInstanceof(mapBrowserEvent, ol.MapBrowserPointerEvent); goog.asserts.assertInstanceof(mapBrowserEvent, ol.MapBrowserPointerEvent);

38
src/ol/extent.js
View File

@@ -12,7 +12,7 @@ goog.require('ol.TransformFunction');
/** /**
* An array of numbers representing an extent: `[minx, miny, maxx, maxy]`. * An array of numbers representing an extent: `[minx, miny, maxx, maxy]`.
* @typedef {Array.<number>} * @typedef {Array.<number>}
* @todo api * @api
*/ */
ol.Extent; ol.Extent;
@@ -36,7 +36,7 @@ ol.extent.Relationship = {
* *
* @param {Array.<ol.Coordinate>} coordinates Coordinates. * @param {Array.<ol.Coordinate>} coordinates Coordinates.
* @return {ol.Extent} Bounding extent. * @return {ol.Extent} Bounding extent.
* @todo api * @api
*/ */
ol.extent.boundingExtent = function(coordinates) { ol.extent.boundingExtent = function(coordinates) {
var extent = ol.extent.createEmpty(); var extent = ol.extent.createEmpty();
@@ -71,7 +71,7 @@ ol.extent.boundingExtentXYs_ = function(xs, ys, opt_extent) {
* @param {number} value The amount by which the extent should be buffered. * @param {number} value The amount by which the extent should be buffered.
* @param {ol.Extent=} opt_extent Extent. * @param {ol.Extent=} opt_extent Extent.
* @return {ol.Extent} Extent. * @return {ol.Extent} Extent.
* @todo api * @api
*/ */
ol.extent.buffer = function(extent, value, opt_extent) { ol.extent.buffer = function(extent, value, opt_extent) {
if (goog.isDef(opt_extent)) { if (goog.isDef(opt_extent)) {
@@ -143,7 +143,7 @@ ol.extent.closestSquaredDistanceXY = function(extent, x, y) {
* @param {ol.Extent} extent Extent. * @param {ol.Extent} extent Extent.
* @param {ol.Coordinate} coordinate Coordinate. * @param {ol.Coordinate} coordinate Coordinate.
* @return {boolean} Contains. * @return {boolean} Contains.
* @todo api * @api
*/ */
ol.extent.containsCoordinate = function(extent, coordinate) { ol.extent.containsCoordinate = function(extent, coordinate) {
return extent[0] <= coordinate[0] && coordinate[0] <= extent[2] && return extent[0] <= coordinate[0] && coordinate[0] <= extent[2] &&
@@ -157,7 +157,7 @@ ol.extent.containsCoordinate = function(extent, coordinate) {
* @param {ol.Extent} extent1 Extent 1. * @param {ol.Extent} extent1 Extent 1.
* @param {ol.Extent} extent2 Extent 2. * @param {ol.Extent} extent2 Extent 2.
* @return {boolean} Contains. * @return {boolean} Contains.
* @todo api * @api
*/ */
ol.extent.containsExtent = function(extent1, extent2) { ol.extent.containsExtent = function(extent1, extent2) {
return extent1[0] <= extent2[0] && extent2[2] <= extent1[2] && return extent1[0] <= extent2[0] && extent2[2] <= extent1[2] &&
@@ -199,7 +199,7 @@ ol.extent.coordinateRelationship = function(extent, coordinate) {
/** /**
* @return {ol.Extent} Empty extent. * @return {ol.Extent} Empty extent.
* @todo api * @api
*/ */
ol.extent.createEmpty = function() { ol.extent.createEmpty = function() {
return [Infinity, Infinity, -Infinity, -Infinity]; return [Infinity, Infinity, -Infinity, -Infinity];
@@ -303,7 +303,7 @@ ol.extent.empty = function(extent) {
* @param {ol.Extent} extent1 Extent 1. * @param {ol.Extent} extent1 Extent 1.
* @param {ol.Extent} extent2 Extent 2. * @param {ol.Extent} extent2 Extent 2.
* @return {boolean} Equals. * @return {boolean} Equals.
* @todo api * @api
*/ */
ol.extent.equals = function(extent1, extent2) { ol.extent.equals = function(extent1, extent2) {
return extent1[0] == extent2[0] && extent1[2] == extent2[2] && return extent1[0] == extent2[0] && extent1[2] == extent2[2] &&
@@ -315,7 +315,7 @@ ol.extent.equals = function(extent1, extent2) {
* @param {ol.Extent} extent1 Extent 1. * @param {ol.Extent} extent1 Extent 1.
* @param {ol.Extent} extent2 Extent 2. * @param {ol.Extent} extent2 Extent 2.
* @return {ol.Extent} Extent. * @return {ol.Extent} Extent.
* @todo api * @api
*/ */
ol.extent.extend = function(extent1, extent2) { ol.extent.extend = function(extent1, extent2) {
if (extent2[0] < extent1[0]) { if (extent2[0] < extent1[0]) {
@@ -425,7 +425,7 @@ ol.extent.getArea = function(extent) {
/** /**
* @param {ol.Extent} extent Extent. * @param {ol.Extent} extent Extent.
* @return {ol.Coordinate} Bottom left coordinate. * @return {ol.Coordinate} Bottom left coordinate.
* @todo api * @api
*/ */
ol.extent.getBottomLeft = function(extent) { ol.extent.getBottomLeft = function(extent) {
return [extent[0], extent[1]]; return [extent[0], extent[1]];
@@ -435,7 +435,7 @@ ol.extent.getBottomLeft = function(extent) {
/** /**
* @param {ol.Extent} extent Extent. * @param {ol.Extent} extent Extent.
* @return {ol.Coordinate} Bottom right coordinate. * @return {ol.Coordinate} Bottom right coordinate.
* @todo api * @api
*/ */
ol.extent.getBottomRight = function(extent) { ol.extent.getBottomRight = function(extent) {
return [extent[2], extent[1]]; return [extent[2], extent[1]];
@@ -445,7 +445,7 @@ ol.extent.getBottomRight = function(extent) {
/** /**
* @param {ol.Extent} extent Extent. * @param {ol.Extent} extent Extent.
* @return {ol.Coordinate} Center. * @return {ol.Coordinate} Center.
* @todo api * @api
*/ */
ol.extent.getCenter = function(extent) { ol.extent.getCenter = function(extent) {
return [(extent[0] + extent[2]) / 2, (extent[1] + extent[3]) / 2]; return [(extent[0] + extent[2]) / 2, (extent[1] + extent[3]) / 2];
@@ -498,7 +498,7 @@ ol.extent.getForViewAndSize =
/** /**
* @param {ol.Extent} extent Extent. * @param {ol.Extent} extent Extent.
* @return {number} Height. * @return {number} Height.
* @todo api * @api
*/ */
ol.extent.getHeight = function(extent) { ol.extent.getHeight = function(extent) {
return extent[3] - extent[1]; return extent[3] - extent[1];
@@ -531,7 +531,7 @@ ol.extent.getMargin = function(extent) {
/** /**
* @param {ol.Extent} extent Extent. * @param {ol.Extent} extent Extent.
* @return {ol.Size} Size. * @return {ol.Size} Size.
* @todo api * @api
*/ */
ol.extent.getSize = function(extent) { ol.extent.getSize = function(extent) {
return [extent[2] - extent[0], extent[3] - extent[1]]; return [extent[2] - extent[0], extent[3] - extent[1]];
@@ -541,7 +541,7 @@ ol.extent.getSize = function(extent) {
/** /**
* @param {ol.Extent} extent Extent. * @param {ol.Extent} extent Extent.
* @return {ol.Coordinate} Top left coordinate. * @return {ol.Coordinate} Top left coordinate.
* @todo api * @api
*/ */
ol.extent.getTopLeft = function(extent) { ol.extent.getTopLeft = function(extent) {
return [extent[0], extent[3]]; return [extent[0], extent[3]];
@@ -551,7 +551,7 @@ ol.extent.getTopLeft = function(extent) {
/** /**
* @param {ol.Extent} extent Extent. * @param {ol.Extent} extent Extent.
* @return {ol.Coordinate} Top right coordinate. * @return {ol.Coordinate} Top right coordinate.
* @todo api * @api
*/ */
ol.extent.getTopRight = function(extent) { ol.extent.getTopRight = function(extent) {
return [extent[2], extent[3]]; return [extent[2], extent[3]];
@@ -561,7 +561,7 @@ ol.extent.getTopRight = function(extent) {
/** /**
* @param {ol.Extent} extent Extent. * @param {ol.Extent} extent Extent.
* @return {number} Width. * @return {number} Width.
* @todo api * @api
*/ */
ol.extent.getWidth = function(extent) { ol.extent.getWidth = function(extent) {
return extent[2] - extent[0]; return extent[2] - extent[0];
@@ -572,7 +572,7 @@ ol.extent.getWidth = function(extent) {
* @param {ol.Extent} extent1 Extent 1. * @param {ol.Extent} extent1 Extent 1.
* @param {ol.Extent} extent2 Extent. * @param {ol.Extent} extent2 Extent.
* @return {boolean} Intersects. * @return {boolean} Intersects.
* @todo api * @api
*/ */
ol.extent.intersects = function(extent1, extent2) { ol.extent.intersects = function(extent1, extent2) {
return extent1[0] <= extent2[2] && return extent1[0] <= extent2[2] &&
@@ -585,7 +585,7 @@ ol.extent.intersects = function(extent1, extent2) {
/** /**
* @param {ol.Extent} extent Extent. * @param {ol.Extent} extent Extent.
* @return {boolean} Is empty. * @return {boolean} Is empty.
* @todo api * @api
*/ */
ol.extent.isEmpty = function(extent) { ol.extent.isEmpty = function(extent) {
return extent[2] < extent[0] || extent[3] < extent[1]; return extent[2] < extent[0] || extent[3] < extent[1];
@@ -720,7 +720,7 @@ ol.extent.touches = function(extent1, extent2) {
* [minX, minY, maxX, maxY] extent coordinates. * [minX, minY, maxX, maxY] extent coordinates.
* @param {ol.Extent=} opt_extent Destination extent. * @param {ol.Extent=} opt_extent Destination extent.
* @return {ol.Extent} Extent. * @return {ol.Extent} Extent.
* @todo api * @api
*/ */
ol.extent.applyTransform = function(extent, transformFn, opt_extent) { ol.extent.applyTransform = function(extent, transformFn, opt_extent) {
var coordinates = [ var coordinates = [

26
src/ol/feature.js
View File

@@ -27,7 +27,7 @@ goog.require('ol.style.Style');
* @fires change Triggered when the geometry or style of the feature changes. * @fires change Triggered when the geometry or style of the feature changes.
* @param {ol.geom.Geometry|Object.<string, *>=} opt_geometryOrProperties * @param {ol.geom.Geometry|Object.<string, *>=} opt_geometryOrProperties
* Geometry or properties. * Geometry or properties.
* @todo api * @api
*/ */
ol.Feature = function(opt_geometryOrProperties) { ol.Feature = function(opt_geometryOrProperties) {
@@ -89,7 +89,7 @@ goog.inherits(ol.Feature, ol.Object);
* Clone this feature. If the original feature has a geometry it * Clone this feature. If the original feature has a geometry it
* is also cloned. The feature id is not set in the clone. * is also cloned. The feature id is not set in the clone.
* @return {ol.Feature} The clone. * @return {ol.Feature} The clone.
* @todo api * @api
*/ */
ol.Feature.prototype.clone = function() { ol.Feature.prototype.clone = function() {
var clone = new ol.Feature(this.getProperties()); var clone = new ol.Feature(this.getProperties());
@@ -108,7 +108,7 @@ ol.Feature.prototype.clone = function() {
/** /**
* @return {ol.geom.Geometry|undefined} Geometry. * @return {ol.geom.Geometry|undefined} Geometry.
* @todo api * @api
*/ */
ol.Feature.prototype.getGeometry = function() { ol.Feature.prototype.getGeometry = function() {
return /** @type {ol.geom.Geometry|undefined} */ ( return /** @type {ol.geom.Geometry|undefined} */ (
@@ -122,7 +122,7 @@ goog.exportProperty(
/** /**
* @return {number|string|undefined} Id. * @return {number|string|undefined} Id.
* @todo api * @api
*/ */
ol.Feature.prototype.getId = function() { ol.Feature.prototype.getId = function() {
return this.id_; return this.id_;
@@ -131,7 +131,7 @@ ol.Feature.prototype.getId = function() {
/** /**
* @return {string} Geometry property name. * @return {string} Geometry property name.
* @todo api * @api
*/ */
ol.Feature.prototype.getGeometryName = function() { ol.Feature.prototype.getGeometryName = function() {
return this.geometryName_; return this.geometryName_;
@@ -141,7 +141,7 @@ ol.Feature.prototype.getGeometryName = function() {
/** /**
* @return {ol.style.Style|Array.<ol.style.Style>| * @return {ol.style.Style|Array.<ol.style.Style>|
* ol.feature.FeatureStyleFunction} User provided style. * ol.feature.FeatureStyleFunction} User provided style.
* @todo api * @api
*/ */
ol.Feature.prototype.getStyle = function() { ol.Feature.prototype.getStyle = function() {
return this.style_; return this.style_;
@@ -150,7 +150,7 @@ ol.Feature.prototype.getStyle = function() {
/** /**
* @return {ol.feature.FeatureStyleFunction|undefined} Style function. * @return {ol.feature.FeatureStyleFunction|undefined} Style function.
* @todo api * @api
*/ */
ol.Feature.prototype.getStyleFunction = function() { ol.Feature.prototype.getStyleFunction = function() {
return this.styleFunction_; return this.styleFunction_;
@@ -184,7 +184,7 @@ ol.Feature.prototype.handleGeometryChanged_ = function() {
/** /**
* @param {ol.geom.Geometry|undefined} geometry Geometry. * @param {ol.geom.Geometry|undefined} geometry Geometry.
* @todo api * @api
*/ */
ol.Feature.prototype.setGeometry = function(geometry) { ol.Feature.prototype.setGeometry = function(geometry) {
this.set(this.geometryName_, geometry); this.set(this.geometryName_, geometry);
@@ -198,7 +198,7 @@ goog.exportProperty(
/** /**
* @param {ol.style.Style|Array.<ol.style.Style>| * @param {ol.style.Style|Array.<ol.style.Style>|
* ol.feature.FeatureStyleFunction} style Feature style. * ol.feature.FeatureStyleFunction} style Feature style.
* @todo api * @api
*/ */
ol.Feature.prototype.setStyle = function(style) { ol.Feature.prototype.setStyle = function(style) {
this.style_ = style; this.style_ = style;
@@ -209,7 +209,7 @@ ol.Feature.prototype.setStyle = function(style) {
/** /**
* @param {number|string|undefined} id Id. * @param {number|string|undefined} id Id.
* @todo api * @api
*/ */
ol.Feature.prototype.setId = function(id) { ol.Feature.prototype.setId = function(id) {
this.id_ = id; this.id_ = id;
@@ -219,7 +219,7 @@ ol.Feature.prototype.setId = function(id) {
/** /**
* @param {string} name Geometry property name. * @param {string} name Geometry property name.
* @todo api * @api
*/ */
ol.Feature.prototype.setGeometryName = function(name) { ol.Feature.prototype.setGeometryName = function(name) {
goog.events.unlisten( goog.events.unlisten(
@@ -240,7 +240,7 @@ ol.Feature.prototype.setGeometryName = function(name) {
* {@link ol.Feature} to be styled. * {@link ol.Feature} to be styled.
* *
* @typedef {function(this: ol.Feature, number): Array.<ol.style.Style>} * @typedef {function(this: ol.Feature, number): Array.<ol.style.Style>}
* @todo api * @api
*/ */
ol.feature.FeatureStyleFunction; ol.feature.FeatureStyleFunction;
@@ -289,7 +289,7 @@ ol.feature.defaultFeatureStyleFunction = function(resolution) {
* {@link ol.style.Style}. This way e.g. a vector layer can be styled. * {@link ol.style.Style}. This way e.g. a vector layer can be styled.
* *
* @typedef {function(ol.Feature, number): Array.<ol.style.Style>} * @typedef {function(ol.Feature, number): Array.<ol.style.Style>}
* @todo api * @api
*/ */
ol.feature.StyleFunction; ol.feature.StyleFunction;

18
src/ol/featureoverlay.js
View File

@@ -25,7 +25,7 @@ goog.require('ol.renderer.vector');
* *
* @constructor * @constructor
* @param {olx.FeatureOverlayOptions=} opt_options Options. * @param {olx.FeatureOverlayOptions=} opt_options Options.
* @todo api * @api
*/ */
ol.FeatureOverlay = function(opt_options) { ol.FeatureOverlay = function(opt_options) {
@@ -97,7 +97,7 @@ ol.FeatureOverlay = function(opt_options) {
/** /**
* @param {ol.Feature} feature Feature. * @param {ol.Feature} feature Feature.
* @todo api * @api
*/ */
ol.FeatureOverlay.prototype.addFeature = function(feature) { ol.FeatureOverlay.prototype.addFeature = function(feature) {
this.features_.push(feature); this.features_.push(feature);
@@ -106,7 +106,7 @@ ol.FeatureOverlay.prototype.addFeature = function(feature) {
/** /**
* @return {ol.Collection} Features collection. * @return {ol.Collection} Features collection.
* @todo api * @api
*/ */
ol.FeatureOverlay.prototype.getFeatures = function() { ol.FeatureOverlay.prototype.getFeatures = function() {
return this.features_; return this.features_;
@@ -195,7 +195,7 @@ ol.FeatureOverlay.prototype.handleMapPostCompose_ = function(event) {
/** /**
* @param {ol.Feature} feature Feature. * @param {ol.Feature} feature Feature.
* @todo api * @api
*/ */
ol.FeatureOverlay.prototype.removeFeature = function(feature) { ol.FeatureOverlay.prototype.removeFeature = function(feature) {
this.features_.remove(feature); this.features_.remove(feature);
@@ -214,7 +214,7 @@ ol.FeatureOverlay.prototype.render_ = function() {
/** /**
* @param {ol.Collection} features Features collection. * @param {ol.Collection} features Features collection.
* @todo api * @api
*/ */
ol.FeatureOverlay.prototype.setFeatures = function(features) { ol.FeatureOverlay.prototype.setFeatures = function(features) {
if (!goog.isNull(this.featuresListenerKeys_)) { if (!goog.isNull(this.featuresListenerKeys_)) {
@@ -248,7 +248,7 @@ ol.FeatureOverlay.prototype.setFeatures = function(features) {
/** /**
* @param {ol.Map} map Map. * @param {ol.Map} map Map.
* @todo api * @api
*/ */
ol.FeatureOverlay.prototype.setMap = function(map) { ol.FeatureOverlay.prototype.setMap = function(map) {
if (!goog.isNull(this.postComposeListenerKey_)) { if (!goog.isNull(this.postComposeListenerKey_)) {
@@ -272,7 +272,7 @@ ol.FeatureOverlay.prototype.setMap = function(map) {
* an array of styles. * an array of styles.
* @param {ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction} style * @param {ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction} style
* Overlay style. * Overlay style.
* @todo api * @api
*/ */
ol.FeatureOverlay.prototype.setStyle = function(style) { ol.FeatureOverlay.prototype.setStyle = function(style) {
this.style_ = style; this.style_ = style;
@@ -286,7 +286,7 @@ ol.FeatureOverlay.prototype.setStyle = function(style) {
* option at construction or to the `setStyle` method. * option at construction or to the `setStyle` method.
* @return {ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction} * @return {ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction}
* Overlay style. * Overlay style.
* @todo api * @api
*/ */
ol.FeatureOverlay.prototype.getStyle = function() { ol.FeatureOverlay.prototype.getStyle = function() {
return this.style_; return this.style_;
@@ -296,7 +296,7 @@ ol.FeatureOverlay.prototype.getStyle = function() {
/** /**
* Get the style function. * Get the style function.
* @return {ol.feature.StyleFunction|undefined} Style function. * @return {ol.feature.StyleFunction|undefined} Style function.
* @todo api * @api
*/ */
ol.FeatureOverlay.prototype.getStyleFunction = function() { ol.FeatureOverlay.prototype.getStyleFunction = function() {
return this.styleFunction_; return this.styleFunction_;

16
src/ol/format/geojsonformat.js
View File

@@ -27,7 +27,7 @@ goog.require('ol.proj');
* @constructor * @constructor
* @extends {ol.format.JSONFeature} * @extends {ol.format.JSONFeature}
* @param {olx.format.GeoJSONOptions=} opt_options Options. * @param {olx.format.GeoJSONOptions=} opt_options Options.
* @todo api * @api
*/ */
ol.format.GeoJSON = function(opt_options) { ol.format.GeoJSON = function(opt_options) {
@@ -331,7 +331,7 @@ ol.format.GeoJSON.prototype.getExtensions = function() {
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.Feature} Feature. * @return {ol.Feature} Feature.
* @todo api * @api
*/ */
ol.format.GeoJSON.prototype.readFeature; ol.format.GeoJSON.prototype.readFeature;
@@ -343,7 +343,7 @@ ol.format.GeoJSON.prototype.readFeature;
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {Array.<ol.Feature>} Features. * @return {Array.<ol.Feature>} Features.
* @todo api * @api
*/ */
ol.format.GeoJSON.prototype.readFeatures; ol.format.GeoJSON.prototype.readFeatures;
@@ -401,7 +401,7 @@ ol.format.GeoJSON.prototype.readFeaturesFromObject = function(object) {
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.geom.Geometry} Geometry. * @return {ol.geom.Geometry} Geometry.
* @todo api * @api
*/ */
ol.format.GeoJSON.prototype.readGeometry; ol.format.GeoJSON.prototype.readGeometry;
@@ -421,7 +421,7 @@ ol.format.GeoJSON.prototype.readGeometryFromObject = function(object) {
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.proj.Projection} Projection. * @return {ol.proj.Projection} Projection.
* @todo api * @api
*/ */
ol.format.GeoJSON.prototype.readProjection; ol.format.GeoJSON.prototype.readProjection;
@@ -457,7 +457,7 @@ ol.format.GeoJSON.prototype.readProjectionFromObject = function(object) {
* @function * @function
* @param {ol.Feature} feature Feature. * @param {ol.Feature} feature Feature.
* @return {ArrayBuffer|Node|Object|string} GeoJSON. * @return {ArrayBuffer|Node|Object|string} GeoJSON.
* @todo api * @api
*/ */
ol.format.GeoJSON.prototype.writeFeature; ol.format.GeoJSON.prototype.writeFeature;
@@ -493,7 +493,7 @@ ol.format.GeoJSON.prototype.writeFeatureObject = function(feature) {
* @function * @function
* @param {Array.<ol.Feature>} features Features. * @param {Array.<ol.Feature>} features Features.
* @return {ArrayBuffer|Node|Object|string} GeoJSON. * @return {ArrayBuffer|Node|Object|string} GeoJSON.
* @todo api * @api
*/ */
ol.format.GeoJSON.prototype.writeFeatures; ol.format.GeoJSON.prototype.writeFeatures;
@@ -520,7 +520,7 @@ ol.format.GeoJSON.prototype.writeFeaturesObject = function(features) {
* @function * @function
* @param {ol.geom.Geometry} geometry Geometry. * @param {ol.geom.Geometry} geometry Geometry.
* @return {ArrayBuffer|Node|Object|string} GeoJSON. * @return {ArrayBuffer|Node|Object|string} GeoJSON.
* @todo api * @api
*/ */
ol.format.GeoJSON.prototype.writeGeometry; ol.format.GeoJSON.prototype.writeGeometry;

6
src/ol/format/gmlformat.js
View File

@@ -31,7 +31,7 @@ goog.require('ol.xml');
* @param {olx.format.GMLOptions=} opt_options * @param {olx.format.GMLOptions=} opt_options
* Optional configuration object. * Optional configuration object.
* @extends {ol.format.XMLFeature} * @extends {ol.format.XMLFeature}
* @todo api * @api
*/ */
ol.format.GML = function(opt_options) { ol.format.GML = function(opt_options) {
var options = /** @type {olx.format.GMLOptions} */ var options = /** @type {olx.format.GMLOptions} */
@@ -1048,7 +1048,7 @@ ol.format.GML.prototype.readGeometryFromNode = function(node) {
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {Array.<ol.Feature>} Features. * @return {Array.<ol.Feature>} Features.
* @todo api * @api
*/ */
ol.format.GML.prototype.readFeatures; ol.format.GML.prototype.readFeatures;
@@ -1690,7 +1690,7 @@ ol.format.GML.prototype.writeGeometryNode = function(geometry) {
* @function * @function
* @param {Array.<ol.Feature>} features Features. * @param {Array.<ol.Feature>} features Features.
* @return {ArrayBuffer|Node|Object|string} Result. * @return {ArrayBuffer|Node|Object|string} Result.
* @todo api * @api
*/ */
ol.format.GML.prototype.writeFeatures; ol.format.GML.prototype.writeFeatures;

10
src/ol/format/gpxformat.js
View File

@@ -22,7 +22,7 @@ goog.require('ol.xml');
* *
* @constructor * @constructor
* @extends {ol.format.XMLFeature} * @extends {ol.format.XMLFeature}
* @todo api * @api
*/ */
ol.format.GPX = function() { ol.format.GPX = function() {
goog.base(this); goog.base(this);
@@ -372,7 +372,7 @@ ol.format.GPX.WPT_PARSERS_ = ol.xml.makeParsersNS(
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.Feature} Feature. * @return {ol.Feature} Feature.
* @todo api * @api
*/ */
ol.format.GPX.prototype.readFeature; ol.format.GPX.prototype.readFeature;
@@ -403,7 +403,7 @@ ol.format.GPX.prototype.readFeatureFromNode = function(node) {
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {Array.<ol.Feature>} Features. * @return {Array.<ol.Feature>} Features.
* @todo api * @api
*/ */
ol.format.GPX.prototype.readFeatures; ol.format.GPX.prototype.readFeatures;
@@ -436,7 +436,7 @@ ol.format.GPX.prototype.readFeaturesFromNode = function(node) {
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.proj.Projection} Projection. * @return {ol.proj.Projection} Projection.
* @todo api * @api
*/ */
ol.format.GPX.prototype.readProjection; ol.format.GPX.prototype.readProjection;
@@ -811,7 +811,7 @@ goog.inherits(ol.format.GPX.V1_1, ol.format.GPX);
* @function * @function
* @param {Array.<ol.Feature>} features Features. * @param {Array.<ol.Feature>} features Features.
* @return {ArrayBuffer|Node|Object|string} Result. * @return {ArrayBuffer|Node|Object|string} Result.
* @todo api * @api
*/ */
ol.format.GPX.prototype.writeFeatures; ol.format.GPX.prototype.writeFeatures;

8
src/ol/format/igcformat.js
View File

@@ -28,7 +28,7 @@ ol.format.IGCZ = {
* @constructor * @constructor
* @extends {ol.format.TextFeature} * @extends {ol.format.TextFeature}
* @param {olx.format.IGCOptions=} opt_options Options. * @param {olx.format.IGCOptions=} opt_options Options.
* @todo api * @api
*/ */
ol.format.IGC = function(opt_options) { ol.format.IGC = function(opt_options) {
@@ -94,7 +94,7 @@ ol.format.IGC.prototype.getExtensions = function() {
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.Feature} Feature. * @return {ol.Feature} Feature.
* @todo api * @api
*/ */
ol.format.IGC.prototype.readFeature; ol.format.IGC.prototype.readFeature;
@@ -180,7 +180,7 @@ ol.format.IGC.prototype.readFeatureFromText = function(text) {
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {Array.<ol.Feature>} Features. * @return {Array.<ol.Feature>} Features.
* @todo api * @api
*/ */
ol.format.IGC.prototype.readFeatures; ol.format.IGC.prototype.readFeatures;
@@ -204,7 +204,7 @@ ol.format.IGC.prototype.readFeaturesFromText = function(text) {
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.proj.Projection} Projection. * @return {ol.proj.Projection} Projection.
* @todo api * @api
*/ */
ol.format.IGC.prototype.readProjection; ol.format.IGC.prototype.readProjection;

12
src/ol/format/kmlformat.js
View File

@@ -62,7 +62,7 @@ ol.format.KMLGxTrackObject_;
* @constructor * @constructor
* @extends {ol.format.XMLFeature} * @extends {ol.format.XMLFeature}
* @param {olx.format.KMLOptions=} opt_options Options. * @param {olx.format.KMLOptions=} opt_options Options.
* @todo api * @api
*/ */
ol.format.KML = function(opt_options) { ol.format.KML = function(opt_options) {
@@ -1488,7 +1488,7 @@ ol.format.KML.prototype.readSharedStyleMap_ = function(node, objectStack) {
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.Feature} Feature. * @return {ol.Feature} Feature.
* @todo api * @api
*/ */
ol.format.KML.prototype.readFeature; ol.format.KML.prototype.readFeature;
@@ -1517,7 +1517,7 @@ ol.format.KML.prototype.readFeatureFromNode = function(node) {
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {Array.<ol.Feature>} Features. * @return {Array.<ol.Feature>} Features.
* @todo api * @api
*/ */
ol.format.KML.prototype.readFeatures; ol.format.KML.prototype.readFeatures;
@@ -1566,7 +1566,7 @@ ol.format.KML.prototype.readFeaturesFromNode = function(node) {
/** /**
* @param {Document|Node|string} source Souce. * @param {Document|Node|string} source Souce.
* @return {string|undefined} Name. * @return {string|undefined} Name.
* @todo api * @api
*/ */
ol.format.KML.prototype.readName = function(source) { ol.format.KML.prototype.readName = function(source) {
if (ol.xml.isDocument(source)) { if (ol.xml.isDocument(source)) {
@@ -1636,7 +1636,7 @@ ol.format.KML.prototype.readNameFromNode = function(node) {
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.proj.Projection} Projection. * @return {ol.proj.Projection} Projection.
* @todo api * @api
*/ */
ol.format.KML.prototype.readProjection; ol.format.KML.prototype.readProjection;
@@ -2495,7 +2495,7 @@ ol.format.KML.OUTER_BOUNDARY_NODE_FACTORY_ =
* @function * @function
* @param {Array.<ol.Feature>} features Features. * @param {Array.<ol.Feature>} features Features.
* @return {ArrayBuffer|Node|Object|string} Result. * @return {ArrayBuffer|Node|Object|string} Result.
* @todo api * @api
*/ */
ol.format.KML.prototype.writeFeatures; ol.format.KML.prototype.writeFeatures;

6
src/ol/format/osmxmlformat.js
View File

@@ -21,7 +21,7 @@ goog.require('ol.xml');
* *
* @constructor * @constructor
* @extends {ol.format.XMLFeature} * @extends {ol.format.XMLFeature}
* @todo api * @api
*/ */
ol.format.OSMXML = function() { ol.format.OSMXML = function() {
goog.base(this); goog.base(this);
@@ -189,7 +189,7 @@ ol.format.OSMXML.NODE_PARSERS_ = ol.xml.makeParsersNS(
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {Array.<ol.Feature>} Features. * @return {Array.<ol.Feature>} Features.
* @todo api * @api
*/ */
ol.format.OSMXML.prototype.readFeatures; ol.format.OSMXML.prototype.readFeatures;
@@ -218,7 +218,7 @@ ol.format.OSMXML.prototype.readFeaturesFromNode = function(node) {
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.proj.Projection} Projection. * @return {ol.proj.Projection} Projection.
* @todo api * @api
*/ */
ol.format.OSMXML.prototype.readProjection; ol.format.OSMXML.prototype.readProjection;

20
src/ol/format/polylineformat.js
View File

@@ -14,7 +14,7 @@ goog.require('ol.proj');
* @extends {ol.format.TextFeature} * @extends {ol.format.TextFeature}
* @param {olx.format.PolylineOptions=} opt_options * @param {olx.format.PolylineOptions=} opt_options
* Optional configuration object. * Optional configuration object.
* @todo api * @api
*/ */
ol.format.Polyline = function(opt_options) { ol.format.Polyline = function(opt_options) {
@@ -42,7 +42,7 @@ goog.inherits(ol.format.Polyline, ol.format.TextFeature);
* multiplied. The remaining decimal places will get rounded away. * multiplied. The remaining decimal places will get rounded away.
* Default is `1e5`. * Default is `1e5`.
* @return {string} The encoded string. * @return {string} The encoded string.
* @todo api * @api
*/ */
ol.format.Polyline.encodeDeltas = function(numbers, stride, opt_factor) { ol.format.Polyline.encodeDeltas = function(numbers, stride, opt_factor) {
var factor = goog.isDef(opt_factor) ? opt_factor : 1e5; var factor = goog.isDef(opt_factor) ? opt_factor : 1e5;
@@ -77,7 +77,7 @@ ol.format.Polyline.encodeDeltas = function(numbers, stride, opt_factor) {
* @param {number=} opt_factor The factor by which the resulting numbers will * @param {number=} opt_factor The factor by which the resulting numbers will
* be divided. Default is `1e5`. * be divided. Default is `1e5`.
* @return {Array.<number>} A list of n-dimensional points. * @return {Array.<number>} A list of n-dimensional points.
* @todo api * @api
*/ */
ol.format.Polyline.decodeDeltas = function(encoded, stride, opt_factor) { ol.format.Polyline.decodeDeltas = function(encoded, stride, opt_factor) {
var factor = goog.isDef(opt_factor) ? opt_factor : 1e5; var factor = goog.isDef(opt_factor) ? opt_factor : 1e5;
@@ -114,7 +114,7 @@ ol.format.Polyline.decodeDeltas = function(encoded, stride, opt_factor) {
* multiplied. The remaining decimal places will get rounded away. * multiplied. The remaining decimal places will get rounded away.
* Default is `1e5`. * Default is `1e5`.
* @return {string} The encoded string. * @return {string} The encoded string.
* @todo api * @api
*/ */
ol.format.Polyline.encodeFloats = function(numbers, opt_factor) { ol.format.Polyline.encodeFloats = function(numbers, opt_factor) {
var factor = goog.isDef(opt_factor) ? opt_factor : 1e5; var factor = goog.isDef(opt_factor) ? opt_factor : 1e5;
@@ -134,7 +134,7 @@ ol.format.Polyline.encodeFloats = function(numbers, opt_factor) {
* @param {number=} opt_factor The factor by which the result will be divided. * @param {number=} opt_factor The factor by which the result will be divided.
* Default is `1e5`. * Default is `1e5`.
* @return {Array.<number>} A list of floating point numbers. * @return {Array.<number>} A list of floating point numbers.
* @todo api * @api
*/ */
ol.format.Polyline.decodeFloats = function(encoded, opt_factor) { ol.format.Polyline.decodeFloats = function(encoded, opt_factor) {
var factor = goog.isDef(opt_factor) ? opt_factor : 1e5; var factor = goog.isDef(opt_factor) ? opt_factor : 1e5;
@@ -249,7 +249,7 @@ ol.format.Polyline.encodeUnsignedInteger = function(num) {
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.Feature} Feature. * @return {ol.Feature} Feature.
* @todo api * @api
*/ */
ol.format.Polyline.prototype.readFeature; ol.format.Polyline.prototype.readFeature;
@@ -270,7 +270,7 @@ ol.format.Polyline.prototype.readFeatureFromText = function(text) {
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {Array.<ol.Feature>} Features. * @return {Array.<ol.Feature>} Features.
* @todo api * @api
*/ */
ol.format.Polyline.prototype.readFeatures; ol.format.Polyline.prototype.readFeatures;
@@ -290,7 +290,7 @@ ol.format.Polyline.prototype.readFeaturesFromText = function(text) {
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.geom.Geometry} Geometry. * @return {ol.geom.Geometry} Geometry.
* @todo api * @api
*/ */
ol.format.Polyline.prototype.readGeometry; ol.format.Polyline.prototype.readGeometry;
@@ -312,7 +312,7 @@ ol.format.Polyline.prototype.readGeometryFromText = function(text) {
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.proj.Projection} Projection. * @return {ol.proj.Projection} Projection.
* @todo api * @api
*/ */
ol.format.Polyline.prototype.readProjection; ol.format.Polyline.prototype.readProjection;
@@ -354,7 +354,7 @@ ol.format.Polyline.prototype.writeFeaturesText = function(features) {
* @function * @function
* @param {ol.geom.Geometry} geometry Geometry. * @param {ol.geom.Geometry} geometry Geometry.
* @return {string} Geometry. * @return {string} Geometry.
* @todo api * @api
*/ */
ol.format.Polyline.prototype.writeGeometry; ol.format.Polyline.prototype.writeGeometry;

6
src/ol/format/topojsonformat.js
View File

@@ -21,7 +21,7 @@ goog.require('ol.proj');
* @constructor * @constructor
* @extends {ol.format.JSONFeature} * @extends {ol.format.JSONFeature}
* @param {olx.format.TopoJSONOptions=} opt_options Options. * @param {olx.format.TopoJSONOptions=} opt_options Options.
* @todo api * @api
*/ */
ol.format.TopoJSON = function(opt_options) { ol.format.TopoJSON = function(opt_options) {
@@ -273,7 +273,7 @@ ol.format.TopoJSON.readFeatureFromGeometry_ = function(object, arcs,
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {Array.<ol.Feature>} Features. * @return {Array.<ol.Feature>} Features.
* @todo api * @api
*/ */
ol.format.TopoJSON.prototype.readFeatures; ol.format.TopoJSON.prototype.readFeatures;
@@ -383,7 +383,7 @@ ol.format.TopoJSON.transformVertex_ = function(vertex, scale, translate) {
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} object Source. * @param {ArrayBuffer|Document|Node|Object|string} object Source.
* @return {ol.proj.Projection} Projection. * @return {ol.proj.Projection} Projection.
* @todo api * @api
*/ */
ol.format.TopoJSON.prototype.readProjection = function(object) { ol.format.TopoJSON.prototype.readProjection = function(object) {
return this.defaultProjection_; return this.defaultProjection_;

14
src/ol/format/wfsformat.js
View File

@@ -20,7 +20,7 @@ goog.require('ol.xml');
* @param {olx.format.WFSOptions=} opt_options * @param {olx.format.WFSOptions=} opt_options
* Optional configuration object. * Optional configuration object.
* @extends {ol.format.XMLFeature} * @extends {ol.format.XMLFeature}
* @todo api * @api
*/ */
ol.format.WFS = function(opt_options) { ol.format.WFS = function(opt_options) {
var options = /** @type {olx.format.WFSOptions} */ var options = /** @type {olx.format.WFSOptions} */
@@ -95,7 +95,7 @@ ol.format.WFS.schemaLocation_ = 'http://www.opengis.net/wfs ' +
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {Array.<ol.Feature>} Features. * @return {Array.<ol.Feature>} Features.
* @todo api * @api
*/ */
ol.format.WFS.prototype.readFeatures; ol.format.WFS.prototype.readFeatures;
@@ -120,7 +120,7 @@ ol.format.WFS.prototype.readFeaturesFromNode = function(node) {
/** /**
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.format.WFS.TransactionResponse|undefined} Transaction response. * @return {ol.format.WFS.TransactionResponse|undefined} Transaction response.
* @todo api * @api
*/ */
ol.format.WFS.prototype.readTransactionResponse = function(source) { ol.format.WFS.prototype.readTransactionResponse = function(source) {
if (ol.xml.isDocument(source)) { if (ol.xml.isDocument(source)) {
@@ -142,7 +142,7 @@ ol.format.WFS.prototype.readTransactionResponse = function(source) {
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.format.WFS.FeatureCollectionMetadata|undefined} * @return {ol.format.WFS.FeatureCollectionMetadata|undefined}
* FeatureCollection metadata. * FeatureCollection metadata.
* @todo api * @api
*/ */
ol.format.WFS.prototype.readFeatureCollectionMetadata = function(source) { ol.format.WFS.prototype.readFeatureCollectionMetadata = function(source) {
if (ol.xml.isDocument(source)) { if (ol.xml.isDocument(source)) {
@@ -591,7 +591,7 @@ ol.format.WFS.writeGetFeature_ = function(node, featureTypes, objectStack) {
/** /**
* @param {olx.format.WFSWriteGetFeatureOptions} options Options. * @param {olx.format.WFSWriteGetFeatureOptions} options Options.
* @return {Node} Result. * @return {Node} Result.
* @todo api * @api
*/ */
ol.format.WFS.prototype.writeGetFeature = function(options) { ol.format.WFS.prototype.writeGetFeature = function(options) {
var node = ol.xml.createElementNS('http://www.opengis.net/wfs', var node = ol.xml.createElementNS('http://www.opengis.net/wfs',
@@ -643,7 +643,7 @@ ol.format.WFS.prototype.writeGetFeature = function(options) {
* @param {Array.<ol.Feature>} deletes The features to delete. * @param {Array.<ol.Feature>} deletes The features to delete.
* @param {olx.format.WFSWriteTransactionOptions} options Write options. * @param {olx.format.WFSWriteTransactionOptions} options Write options.
* @return {Node} Result. * @return {Node} Result.
* @todo api * @api
*/ */
ol.format.WFS.prototype.writeTransaction = function(inserts, updates, deletes, ol.format.WFS.prototype.writeTransaction = function(inserts, updates, deletes,
options) { options) {
@@ -703,7 +703,7 @@ ol.format.WFS.prototype.writeTransaction = function(inserts, updates, deletes,
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {?ol.proj.Projection} Projection. * @return {?ol.proj.Projection} Projection.
* @todo api * @api
*/ */
ol.format.WFS.prototype.readProjection; ol.format.WFS.prototype.readProjection;

14
src/ol/format/wktformat.js
View File

@@ -21,7 +21,7 @@ goog.require('ol.geom.Polygon');
* @extends {ol.format.TextFeature} * @extends {ol.format.TextFeature}
* @param {olx.format.WKTOptions=} opt_options Options. * @param {olx.format.WKTOptions=} opt_options Options.
* @todo stability experimental * @todo stability experimental
* @todo api * @api
*/ */
ol.format.WKT = function(opt_options) { ol.format.WKT = function(opt_options) {
@@ -352,7 +352,7 @@ ol.format.WKT.prototype.encode_ = function(geom) {
* *
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.Feature} Feature. * @return {ol.Feature} Feature.
* @todo api * @api
*/ */
ol.format.WKT.prototype.readFeature; ol.format.WKT.prototype.readFeature;
@@ -376,7 +376,7 @@ ol.format.WKT.prototype.readFeatureFromText = function(text) {
* *
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {Array.<ol.Feature>} Features. * @return {Array.<ol.Feature>} Features.
* @todo api * @api
*/ */
ol.format.WKT.prototype.readFeatures; ol.format.WKT.prototype.readFeatures;
@@ -409,7 +409,7 @@ ol.format.WKT.prototype.readFeaturesFromText = function(text) {
* *
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.geom.Geometry} Geometry. * @return {ol.geom.Geometry} Geometry.
* @todo api * @api
*/ */
ol.format.WKT.prototype.readGeometry; ol.format.WKT.prototype.readGeometry;
@@ -435,7 +435,7 @@ ol.format.WKT.prototype.readProjectionFromText = function(text) {
* *
* @param {ol.Feature} feature Feature. * @param {ol.Feature} feature Feature.
* @return {ArrayBuffer|Node|Object|string} Result. * @return {ArrayBuffer|Node|Object|string} Result.
* @todo api * @api
*/ */
ol.format.WKT.prototype.writeFeature; ol.format.WKT.prototype.writeFeature;
@@ -457,7 +457,7 @@ ol.format.WKT.prototype.writeFeatureText = function(feature) {
* *
* @param {Array.<ol.Feature>} features Features. * @param {Array.<ol.Feature>} features Features.
* @return {ArrayBuffer|Node|Object|string} Result. * @return {ArrayBuffer|Node|Object|string} Result.
* @todo api * @api
*/ */
ol.format.WKT.prototype.writeFeatures; ol.format.WKT.prototype.writeFeatures;
@@ -483,7 +483,7 @@ ol.format.WKT.prototype.writeFeaturesText = function(features) {
* *
* @param {ol.geom.Geometry} geometry Geometry. * @param {ol.geom.Geometry} geometry Geometry.
* @return {ArrayBuffer|Node|Object|string} Node. * @return {ArrayBuffer|Node|Object|string} Node.
* @todo api * @api
*/ */
ol.format.WKT.prototype.writeGeometry; ol.format.WKT.prototype.writeGeometry;

4
src/ol/format/wmscapabilitiesformat.js
View File

@@ -18,7 +18,7 @@ goog.require('ol.xml');
* *
* @constructor * @constructor
* @extends {ol.format.XML} * @extends {ol.format.XML}
* @todo api * @api
*/ */
ol.format.WMSCapabilities = function() { ol.format.WMSCapabilities = function() {
@@ -38,7 +38,7 @@ goog.inherits(ol.format.WMSCapabilities, ol.format.XML);
* @function * @function
* @param {Document|Node|string} source The XML source. * @param {Document|Node|string} source The XML source.
* @return {Object} An object representing the WMS capabilities. * @return {Object} An object representing the WMS capabilities.
* @todo api * @api
*/ */
ol.format.WMSCapabilities.prototype.read; ol.format.WMSCapabilities.prototype.read;

2
src/ol/framestate.js
View File

@@ -16,6 +16,6 @@ ol.PostRenderFunction;
* second argument. Return `true` to keep this function for the next frame, * second argument. Return `true` to keep this function for the next frame,
* `false` to remove it. * `false` to remove it.
* @typedef {function(ol.Map, ?olx.FrameState): boolean} * @typedef {function(ol.Map, ?olx.FrameState): boolean}
* @todo api * @api
*/ */
ol.PreRenderFunction; ol.PreRenderFunction;

28
src/ol/geolocation.js
View File

@@ -54,7 +54,7 @@ ol.GeolocationProperty = {
* @extends {ol.Object} * @extends {ol.Object}
* @fires change Triggered when the position changes. * @fires change Triggered when the position changes.
* @param {olx.GeolocationOptions=} opt_options Options. * @param {olx.GeolocationOptions=} opt_options Options.
* @todo api * @api
*/ */
ol.Geolocation = function(opt_options) { ol.Geolocation = function(opt_options) {
@@ -192,7 +192,7 @@ ol.Geolocation.prototype.positionError_ = function(error) {
* @return {number|undefined} The accuracy of the position measurement in * @return {number|undefined} The accuracy of the position measurement in
* meters. * meters.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.Geolocation.prototype.getAccuracy = function() { ol.Geolocation.prototype.getAccuracy = function() {
return /** @type {number|undefined} */ ( return /** @type {number|undefined} */ (
@@ -208,7 +208,7 @@ goog.exportProperty(
* Get a geometry of the position accuracy. * Get a geometry of the position accuracy.
* @return {?ol.geom.Geometry} A geometry of the position accuracy. * @return {?ol.geom.Geometry} A geometry of the position accuracy.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.Geolocation.prototype.getAccuracyGeometry = function() { ol.Geolocation.prototype.getAccuracyGeometry = function() {
return /** @type {?ol.geom.Geometry} */ ( return /** @type {?ol.geom.Geometry} */ (
@@ -225,7 +225,7 @@ goog.exportProperty(
* @return {number|undefined} The altitude of the position in meters above mean * @return {number|undefined} The altitude of the position in meters above mean
* sea level. * sea level.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.Geolocation.prototype.getAltitude = function() { ol.Geolocation.prototype.getAltitude = function() {
return /** @type {number|undefined} */ ( return /** @type {number|undefined} */ (
@@ -242,7 +242,7 @@ goog.exportProperty(
* @return {number|undefined} The accuracy of the altitude measurement in * @return {number|undefined} The accuracy of the altitude measurement in
* meters. * meters.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.Geolocation.prototype.getAltitudeAccuracy = function() { ol.Geolocation.prototype.getAltitudeAccuracy = function() {
return /** @type {number|undefined} */ ( return /** @type {number|undefined} */ (
@@ -258,7 +258,7 @@ goog.exportProperty(
* Get the heading as radians clockwise from North. * Get the heading as radians clockwise from North.
* @return {number|undefined} The heading of the device in radians from north. * @return {number|undefined} The heading of the device in radians from north.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.Geolocation.prototype.getHeading = function() { ol.Geolocation.prototype.getHeading = function() {
return /** @type {number|undefined} */ ( return /** @type {number|undefined} */ (
@@ -275,7 +275,7 @@ goog.exportProperty(
* @return {ol.Coordinate|undefined} The current position of the device reported * @return {ol.Coordinate|undefined} The current position of the device reported
* in the current projection. * in the current projection.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.Geolocation.prototype.getPosition = function() { ol.Geolocation.prototype.getPosition = function() {
return /** @type {ol.Coordinate|undefined} */ ( return /** @type {ol.Coordinate|undefined} */ (
@@ -292,7 +292,7 @@ goog.exportProperty(
* @return {ol.proj.Projection|undefined} The projection the position is * @return {ol.proj.Projection|undefined} The projection the position is
* reported in. * reported in.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.Geolocation.prototype.getProjection = function() { ol.Geolocation.prototype.getProjection = function() {
return /** @type {ol.proj.Projection|undefined} */ ( return /** @type {ol.proj.Projection|undefined} */ (
@@ -309,7 +309,7 @@ goog.exportProperty(
* @return {number|undefined} The instantaneous speed of the device in meters * @return {number|undefined} The instantaneous speed of the device in meters
* per second. * per second.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.Geolocation.prototype.getSpeed = function() { ol.Geolocation.prototype.getSpeed = function() {
return /** @type {number|undefined} */ ( return /** @type {number|undefined} */ (
@@ -325,7 +325,7 @@ goog.exportProperty(
* Are we tracking the user's position? * Are we tracking the user's position?
* @return {boolean} Whether to track the device's position. * @return {boolean} Whether to track the device's position.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.Geolocation.prototype.getTracking = function() { ol.Geolocation.prototype.getTracking = function() {
return /** @type {boolean} */ ( return /** @type {boolean} */ (
@@ -344,7 +344,7 @@ goog.exportProperty(
* the HTML5 Geolocation spec at * the HTML5 Geolocation spec at
* {@link http://www.w3.org/TR/geolocation-API/#position_options_interface} * {@link http://www.w3.org/TR/geolocation-API/#position_options_interface}
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.Geolocation.prototype.getTrackingOptions = function() { ol.Geolocation.prototype.getTrackingOptions = function() {
return /** @type {GeolocationPositionOptions|undefined} */ ( return /** @type {GeolocationPositionOptions|undefined} */ (
@@ -361,7 +361,7 @@ goog.exportProperty(
* @param {ol.proj.Projection} projection The projection the position is * @param {ol.proj.Projection} projection The projection the position is
* reported in. * reported in.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.Geolocation.prototype.setProjection = function(projection) { ol.Geolocation.prototype.setProjection = function(projection) {
this.set(ol.GeolocationProperty.PROJECTION, projection); this.set(ol.GeolocationProperty.PROJECTION, projection);
@@ -376,7 +376,7 @@ goog.exportProperty(
* Enable/disable tracking. * Enable/disable tracking.
* @param {boolean} tracking Whether to track the device's position. * @param {boolean} tracking Whether to track the device's position.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.Geolocation.prototype.setTracking = function(tracking) { ol.Geolocation.prototype.setTracking = function(tracking) {
this.set(ol.GeolocationProperty.TRACKING, tracking); this.set(ol.GeolocationProperty.TRACKING, tracking);
@@ -394,7 +394,7 @@ goog.exportProperty(
* HTML5 Geolocation spec at * HTML5 Geolocation spec at
* {@link http://www.w3.org/TR/geolocation-API/#position_options_interface} * {@link http://www.w3.org/TR/geolocation-API/#position_options_interface}
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.Geolocation.prototype.setTrackingOptions = function(options) { ol.Geolocation.prototype.setTrackingOptions = function(options) {
this.set(ol.GeolocationProperty.TRACKING_OPTIONS, options); this.set(ol.GeolocationProperty.TRACKING_OPTIONS, options);

18
src/ol/geom/circle.js
View File

@@ -17,7 +17,7 @@ goog.require('ol.geom.flat.deflate');
* @param {ol.geom.RawPoint} center Center. * @param {ol.geom.RawPoint} center Center.
* @param {number=} opt_radius Radius. * @param {number=} opt_radius Radius.
* @param {ol.geom.GeometryLayout=} opt_layout Layout. * @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo api * @api
*/ */
ol.geom.Circle = function(center, opt_radius, opt_layout) { ol.geom.Circle = function(center, opt_radius, opt_layout) {
goog.base(this); goog.base(this);
@@ -30,7 +30,7 @@ goog.inherits(ol.geom.Circle, ol.geom.SimpleGeometry);
/** /**
* @inheritDoc * @inheritDoc
* @todo api * @api
*/ */
ol.geom.Circle.prototype.clone = function() { ol.geom.Circle.prototype.clone = function() {
var circle = new ol.geom.Circle(null); var circle = new ol.geom.Circle(null);
@@ -83,7 +83,7 @@ ol.geom.Circle.prototype.containsXY = function(x, y) {
/** /**
* @return {ol.geom.RawPoint} Center. * @return {ol.geom.RawPoint} Center.
* @todo api * @api
*/ */
ol.geom.Circle.prototype.getCenter = function() { ol.geom.Circle.prototype.getCenter = function() {
return this.flatCoordinates.slice(0, this.stride); return this.flatCoordinates.slice(0, this.stride);
@@ -92,7 +92,7 @@ ol.geom.Circle.prototype.getCenter = function() {
/** /**
* @inheritDoc * @inheritDoc
* @todo api * @api
*/ */
ol.geom.Circle.prototype.getExtent = function(opt_extent) { ol.geom.Circle.prototype.getExtent = function(opt_extent) {
if (this.extentRevision != this.getRevision()) { if (this.extentRevision != this.getRevision()) {
@@ -111,7 +111,7 @@ ol.geom.Circle.prototype.getExtent = function(opt_extent) {
/** /**
* @return {number} Radius. * @return {number} Radius.
* @todo api * @api
*/ */
ol.geom.Circle.prototype.getRadius = function() { ol.geom.Circle.prototype.getRadius = function() {
return Math.sqrt(this.getRadiusSquared_()); return Math.sqrt(this.getRadiusSquared_());
@@ -131,7 +131,7 @@ ol.geom.Circle.prototype.getRadiusSquared_ = function() {
/** /**
* @inheritDoc * @inheritDoc
* @todo api * @api
*/ */
ol.geom.Circle.prototype.getType = function() { ol.geom.Circle.prototype.getType = function() {
return ol.geom.GeometryType.CIRCLE; return ol.geom.GeometryType.CIRCLE;
@@ -140,7 +140,7 @@ ol.geom.Circle.prototype.getType = function() {
/** /**
* @param {ol.geom.RawPoint} center Center. * @param {ol.geom.RawPoint} center Center.
* @todo api * @api
*/ */
ol.geom.Circle.prototype.setCenter = function(center) { ol.geom.Circle.prototype.setCenter = function(center) {
var stride = this.stride; var stride = this.stride;
@@ -160,7 +160,7 @@ ol.geom.Circle.prototype.setCenter = function(center) {
* @param {ol.geom.RawPoint} center Center. * @param {ol.geom.RawPoint} center Center.
* @param {number} radius Radius. * @param {number} radius Radius.
* @param {ol.geom.GeometryLayout=} opt_layout Layout. * @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo api * @api
*/ */
ol.geom.Circle.prototype.setCenterAndRadius = ol.geom.Circle.prototype.setCenterAndRadius =
function(center, radius, opt_layout) { function(center, radius, opt_layout) {
@@ -199,7 +199,7 @@ ol.geom.Circle.prototype.setFlatCoordinates =
/** /**
* @param {number} radius Radius. * @param {number} radius Radius.
* @todo api * @api
*/ */
ol.geom.Circle.prototype.setRadius = function(radius) { ol.geom.Circle.prototype.setRadius = function(radius) {
goog.asserts.assert(!goog.isNull(this.flatCoordinates)); goog.asserts.assert(!goog.isNull(this.flatCoordinates));

28
src/ol/geom/geometry.js
View File

@@ -12,7 +12,7 @@ goog.require('ol.proj');
* `'Polygon'`, `'MultiPoint'`, `'MultiLineString'`, `'MultiPolygon'`, * `'Polygon'`, `'MultiPoint'`, `'MultiLineString'`, `'MultiPolygon'`,
* `'GeometryCollection'`, `'Circle'`. * `'GeometryCollection'`, `'Circle'`.
* @enum {string} * @enum {string}
* @todo api * @api
*/ */
ol.geom.GeometryType = { ol.geom.GeometryType = {
POINT: 'Point', POINT: 'Point',
@@ -32,7 +32,7 @@ ol.geom.GeometryType = {
* or measure ('M') coordinate is available. Supported values are `'XY'`, * or measure ('M') coordinate is available. Supported values are `'XY'`,
* `'XYZ'`, `'XYM'`, `'XYZM'`. * `'XYZ'`, `'XYM'`, `'XYZM'`.
* @enum {string} * @enum {string}
* @todo api * @api
*/ */
ol.geom.GeometryLayout = { ol.geom.GeometryLayout = {
XY: 'XY', XY: 'XY',
@@ -52,7 +52,7 @@ ol.geom.GeometryLayout = {
* @constructor * @constructor
* @extends {ol.Observable} * @extends {ol.Observable}
* @fires change Triggered when the geometry changes. * @fires change Triggered when the geometry changes.
* @todo api * @api
*/ */
ol.geom.Geometry = function() { ol.geom.Geometry = function() {
@@ -113,7 +113,7 @@ ol.geom.Geometry.prototype.closestPointXY = goog.abstractMethod;
* @param {ol.Coordinate} point Point. * @param {ol.Coordinate} point Point.
* @param {ol.Coordinate=} opt_closestPoint Closest point. * @param {ol.Coordinate=} opt_closestPoint Closest point.
* @return {ol.Coordinate} Closest point. * @return {ol.Coordinate} Closest point.
* @todo api * @api
*/ */
ol.geom.Geometry.prototype.getClosestPoint = function(point, opt_closestPoint) { ol.geom.Geometry.prototype.getClosestPoint = function(point, opt_closestPoint) {
var closestPoint = goog.isDef(opt_closestPoint) ? var closestPoint = goog.isDef(opt_closestPoint) ?
@@ -145,7 +145,7 @@ ol.geom.Geometry.prototype.containsXY = goog.functions.FALSE;
* @function * @function
* @param {ol.Extent=} opt_extent Extent. * @param {ol.Extent=} opt_extent Extent.
* @return {ol.Extent} extent Extent. * @return {ol.Extent} extent Extent.
* @todo api * @api
*/ */
ol.geom.Geometry.prototype.getExtent = goog.abstractMethod; ol.geom.Geometry.prototype.getExtent = goog.abstractMethod;
@@ -171,7 +171,7 @@ ol.geom.Geometry.prototype.getType = goog.abstractMethod;
* then use this function on the clone. * then use this function on the clone.
* @function * @function
* @param {ol.TransformFunction} transformFn Transform. * @param {ol.TransformFunction} transformFn Transform.
* @todo api * @api
*/ */
ol.geom.Geometry.prototype.applyTransform = goog.abstractMethod; ol.geom.Geometry.prototype.applyTransform = goog.abstractMethod;
@@ -188,7 +188,7 @@ ol.geom.Geometry.prototype.applyTransform = goog.abstractMethod;
* string identifier or a {@link ol.proj.Projection} object. * string identifier or a {@link ol.proj.Projection} object.
* @return {ol.geom.Geometry} This geometry. Note that original geometry is * @return {ol.geom.Geometry} This geometry. Note that original geometry is
* modified in place. * modified in place.
* @todo api * @api
*/ */
ol.geom.Geometry.prototype.transform = function(source, destination) { ol.geom.Geometry.prototype.transform = function(source, destination) {
this.applyTransform(ol.proj.getTransform(source, destination)); this.applyTransform(ol.proj.getTransform(source, destination));
@@ -199,7 +199,7 @@ ol.geom.Geometry.prototype.transform = function(source, destination) {
/** /**
* Array representation of a point. Example: `[16, 48]`. * Array representation of a point. Example: `[16, 48]`.
* @typedef {ol.Coordinate} * @typedef {ol.Coordinate}
* @todo api * @api
*/ */
ol.geom.RawPoint; ol.geom.RawPoint;
@@ -207,7 +207,7 @@ ol.geom.RawPoint;
/** /**
* Array representation of a linestring. * Array representation of a linestring.
* @typedef {Array.<ol.Coordinate>} * @typedef {Array.<ol.Coordinate>}
* @todo api * @api
*/ */
ol.geom.RawLineString; ol.geom.RawLineString;
@@ -215,7 +215,7 @@ ol.geom.RawLineString;
/** /**
* Array representation of a linear ring. * Array representation of a linear ring.
* @typedef {Array.<ol.Coordinate>} * @typedef {Array.<ol.Coordinate>}
* @todo api * @api
*/ */
ol.geom.RawLinearRing; ol.geom.RawLinearRing;
@@ -223,7 +223,7 @@ ol.geom.RawLinearRing;
/** /**
* Array representation of a polygon. * Array representation of a polygon.
* @typedef {Array.<ol.geom.RawLinearRing>} * @typedef {Array.<ol.geom.RawLinearRing>}
* @todo api * @api
*/ */
ol.geom.RawPolygon; ol.geom.RawPolygon;
@@ -231,7 +231,7 @@ ol.geom.RawPolygon;
/** /**
* Array representation of a multipoint. * Array representation of a multipoint.
* @typedef {Array.<ol.geom.RawPoint>} * @typedef {Array.<ol.geom.RawPoint>}
* @todo api * @api
*/ */
ol.geom.RawMultiPoint; ol.geom.RawMultiPoint;
@@ -239,7 +239,7 @@ ol.geom.RawMultiPoint;
/** /**
* Array representation of a multilinestring. * Array representation of a multilinestring.
* @typedef {Array.<ol.geom.RawLineString>} * @typedef {Array.<ol.geom.RawLineString>}
* @todo api * @api
*/ */
ol.geom.RawMultiLineString; ol.geom.RawMultiLineString;
@@ -247,6 +247,6 @@ ol.geom.RawMultiLineString;
/** /**
* Array representation of a multipolygon. * Array representation of a multipolygon.
* @typedef {Array.<ol.geom.RawPolygon>} * @typedef {Array.<ol.geom.RawPolygon>}
* @todo api * @api
*/ */
ol.geom.RawMultiPolygon; ol.geom.RawMultiPolygon;

14
src/ol/geom/geometrycollection.js
View File

@@ -18,7 +18,7 @@ goog.require('ol.geom.GeometryType');
* @constructor * @constructor
* @extends {ol.geom.Geometry} * @extends {ol.geom.Geometry}
* @param {Array.<ol.geom.Geometry>=} opt_geometries Geometries. * @param {Array.<ol.geom.Geometry>=} opt_geometries Geometries.
* @todo api * @api
*/ */
ol.geom.GeometryCollection = function(opt_geometries) { ol.geom.GeometryCollection = function(opt_geometries) {
@@ -84,7 +84,7 @@ ol.geom.GeometryCollection.prototype.listenGeometriesChange_ = function() {
/** /**
* @inheritDoc * @inheritDoc
* @todo api * @api
*/ */
ol.geom.GeometryCollection.prototype.clone = function() { ol.geom.GeometryCollection.prototype.clone = function() {
var geometryCollection = new ol.geom.GeometryCollection(null); var geometryCollection = new ol.geom.GeometryCollection(null);
@@ -129,7 +129,7 @@ ol.geom.GeometryCollection.prototype.containsXY = function(x, y) {
/** /**
* @inheritDoc * @inheritDoc
* @todo api * @api
*/ */
ol.geom.GeometryCollection.prototype.getExtent = function(opt_extent) { ol.geom.GeometryCollection.prototype.getExtent = function(opt_extent) {
if (this.extentRevision != this.getRevision()) { if (this.extentRevision != this.getRevision()) {
@@ -149,7 +149,7 @@ ol.geom.GeometryCollection.prototype.getExtent = function(opt_extent) {
/** /**
* @return {Array.<ol.geom.Geometry>} Geometries. * @return {Array.<ol.geom.Geometry>} Geometries.
* @todo api * @api
*/ */
ol.geom.GeometryCollection.prototype.getGeometries = function() { ol.geom.GeometryCollection.prototype.getGeometries = function() {
return ol.geom.GeometryCollection.cloneGeometries_(this.geometries_); return ol.geom.GeometryCollection.cloneGeometries_(this.geometries_);
@@ -166,7 +166,7 @@ ol.geom.GeometryCollection.prototype.getGeometriesArray = function() {
/** /**
* @inheritDoc * @inheritDoc
* @todo api * @api
*/ */
ol.geom.GeometryCollection.prototype.getSimplifiedGeometry = ol.geom.GeometryCollection.prototype.getSimplifiedGeometry =
function(squaredTolerance) { function(squaredTolerance) {
@@ -211,7 +211,7 @@ ol.geom.GeometryCollection.prototype.getSimplifiedGeometry =
/** /**
* @inheritDoc * @inheritDoc
* @todo api * @api
*/ */
ol.geom.GeometryCollection.prototype.getType = function() { ol.geom.GeometryCollection.prototype.getType = function() {
return ol.geom.GeometryType.GEOMETRY_COLLECTION; return ol.geom.GeometryType.GEOMETRY_COLLECTION;
@@ -228,7 +228,7 @@ ol.geom.GeometryCollection.prototype.isEmpty = function() {
/** /**
* @param {Array.<ol.geom.Geometry>} geometries Geometries. * @param {Array.<ol.geom.Geometry>} geometries Geometries.
* @todo api * @api
*/ */
ol.geom.GeometryCollection.prototype.setGeometries = function(geometries) { ol.geom.GeometryCollection.prototype.setGeometries = function(geometries) {
this.setGeometriesArray( this.setGeometriesArray(

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

@@ -19,7 +19,7 @@ goog.require('ol.geom.flat.simplify');
* @extends {ol.geom.SimpleGeometry} * @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawLinearRing} coordinates Coordinates. * @param {ol.geom.RawLinearRing} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout. * @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo api * @api
*/ */
ol.geom.LinearRing = function(coordinates, opt_layout) { ol.geom.LinearRing = function(coordinates, opt_layout) {
@@ -46,7 +46,7 @@ goog.inherits(ol.geom.LinearRing, ol.geom.SimpleGeometry);
/** /**
* @inheritDoc * @inheritDoc
* @todo api * @api
*/ */
ol.geom.LinearRing.prototype.clone = function() { ol.geom.LinearRing.prototype.clone = function() {
var linearRing = new ol.geom.LinearRing(null); var linearRing = new ol.geom.LinearRing(null);
@@ -77,7 +77,7 @@ ol.geom.LinearRing.prototype.closestPointXY =
/** /**
* @return {number} Area. * @return {number} Area.
* @todo api * @api
*/ */
ol.geom.LinearRing.prototype.getArea = function() { ol.geom.LinearRing.prototype.getArea = function() {
return ol.geom.flat.area.linearRing( return ol.geom.flat.area.linearRing(
@@ -87,7 +87,7 @@ ol.geom.LinearRing.prototype.getArea = function() {
/** /**
* @return {ol.geom.RawLinearRing} Coordinates. * @return {ol.geom.RawLinearRing} Coordinates.
* @todo api * @api
*/ */
ol.geom.LinearRing.prototype.getCoordinates = function() { ol.geom.LinearRing.prototype.getCoordinates = function() {
return ol.geom.flat.inflate.coordinates( return ol.geom.flat.inflate.coordinates(
@@ -113,7 +113,7 @@ ol.geom.LinearRing.prototype.getSimplifiedGeometryInternal =
/** /**
* @inheritDoc * @inheritDoc
* @todo api * @api
*/ */
ol.geom.LinearRing.prototype.getType = function() { ol.geom.LinearRing.prototype.getType = function() {
return ol.geom.GeometryType.LINEAR_RING; return ol.geom.GeometryType.LINEAR_RING;
@@ -123,7 +123,7 @@ ol.geom.LinearRing.prototype.getType = function() {
/** /**
* @param {ol.geom.RawLinearRing} coordinates Coordinates. * @param {ol.geom.RawLinearRing} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout. * @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo api * @api
*/ */
ol.geom.LinearRing.prototype.setCoordinates = ol.geom.LinearRing.prototype.setCoordinates =
function(coordinates, opt_layout) { function(coordinates, opt_layout) {

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

@@ -22,7 +22,7 @@ goog.require('ol.geom.flat.simplify');
* @extends {ol.geom.SimpleGeometry} * @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawLineString} coordinates Coordinates. * @param {ol.geom.RawLineString} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout. * @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo api * @api
*/ */
ol.geom.LineString = function(coordinates, opt_layout) { ol.geom.LineString = function(coordinates, opt_layout) {
@@ -61,7 +61,7 @@ goog.inherits(ol.geom.LineString, ol.geom.SimpleGeometry);
/** /**
* @param {ol.Coordinate} coordinate Coordinate. * @param {ol.Coordinate} coordinate Coordinate.
* @todo api * @api
*/ */
ol.geom.LineString.prototype.appendCoordinate = function(coordinate) { ol.geom.LineString.prototype.appendCoordinate = function(coordinate) {
goog.asserts.assert(coordinate.length == this.stride); goog.asserts.assert(coordinate.length == this.stride);
@@ -76,7 +76,7 @@ ol.geom.LineString.prototype.appendCoordinate = function(coordinate) {
/** /**
* @inheritDoc * @inheritDoc
* @todo api * @api
*/ */
ol.geom.LineString.prototype.clone = function() { ol.geom.LineString.prototype.clone = function() {
var lineString = new ol.geom.LineString(null); var lineString = new ol.geom.LineString(null);
@@ -117,7 +117,7 @@ ol.geom.LineString.prototype.closestPointXY =
* @param {number} m M. * @param {number} m M.
* @param {boolean=} opt_extrapolate Extrapolate. * @param {boolean=} opt_extrapolate Extrapolate.
* @return {ol.Coordinate} Coordinate. * @return {ol.Coordinate} Coordinate.
* @todo api * @api
*/ */
ol.geom.LineString.prototype.getCoordinateAtM = function(m, opt_extrapolate) { ol.geom.LineString.prototype.getCoordinateAtM = function(m, opt_extrapolate) {
if (this.layout != ol.geom.GeometryLayout.XYM && if (this.layout != ol.geom.GeometryLayout.XYM &&
@@ -132,7 +132,7 @@ ol.geom.LineString.prototype.getCoordinateAtM = function(m, opt_extrapolate) {
/** /**
* @return {ol.geom.RawLineString} Coordinates. * @return {ol.geom.RawLineString} Coordinates.
* @todo api * @api
*/ */
ol.geom.LineString.prototype.getCoordinates = function() { ol.geom.LineString.prototype.getCoordinates = function() {
return ol.geom.flat.inflate.coordinates( return ol.geom.flat.inflate.coordinates(
@@ -142,7 +142,7 @@ ol.geom.LineString.prototype.getCoordinates = function() {
/** /**
* @return {number} Length. * @return {number} Length.
* @todo api * @api
*/ */
ol.geom.LineString.prototype.getLength = function() { ol.geom.LineString.prototype.getLength = function() {
return ol.geom.flat.length.lineString( return ol.geom.flat.length.lineString(
@@ -182,7 +182,7 @@ ol.geom.LineString.prototype.getSimplifiedGeometryInternal =
/** /**
* @inheritDoc * @inheritDoc
* @todo api * @api
*/ */
ol.geom.LineString.prototype.getType = function() { ol.geom.LineString.prototype.getType = function() {
return ol.geom.GeometryType.LINE_STRING; return ol.geom.GeometryType.LINE_STRING;
@@ -192,7 +192,7 @@ ol.geom.LineString.prototype.getType = function() {
/** /**
* @param {ol.geom.RawLineString} coordinates Coordinates. * @param {ol.geom.RawLineString} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout. * @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo api * @api
*/ */
ol.geom.LineString.prototype.setCoordinates = ol.geom.LineString.prototype.setCoordinates =
function(coordinates, opt_layout) { function(coordinates, opt_layout) {

18
src/ol/geom/multilinestring.js
View File

@@ -22,7 +22,7 @@ goog.require('ol.geom.flat.simplify');
* @extends {ol.geom.SimpleGeometry} * @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawMultiLineString} coordinates Coordinates. * @param {ol.geom.RawMultiLineString} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout. * @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo api * @api
*/ */
ol.geom.MultiLineString = function(coordinates, opt_layout) { ol.geom.MultiLineString = function(coordinates, opt_layout) {
@@ -55,7 +55,7 @@ goog.inherits(ol.geom.MultiLineString, ol.geom.SimpleGeometry);
/** /**
* @param {ol.geom.LineString} lineString LineString. * @param {ol.geom.LineString} lineString LineString.
* @todo api * @api
*/ */
ol.geom.MultiLineString.prototype.appendLineString = function(lineString) { ol.geom.MultiLineString.prototype.appendLineString = function(lineString) {
goog.asserts.assert(lineString.getLayout() == this.layout); goog.asserts.assert(lineString.getLayout() == this.layout);
@@ -72,7 +72,7 @@ ol.geom.MultiLineString.prototype.appendLineString = function(lineString) {
/** /**
* @inheritDoc * @inheritDoc
* @todo api * @api
*/ */
ol.geom.MultiLineString.prototype.clone = function() { ol.geom.MultiLineString.prototype.clone = function() {
var multiLineString = new ol.geom.MultiLineString(null); var multiLineString = new ol.geom.MultiLineString(null);
@@ -122,7 +122,7 @@ ol.geom.MultiLineString.prototype.closestPointXY =
* @param {boolean=} opt_extrapolate Extrapolate. * @param {boolean=} opt_extrapolate Extrapolate.
* @param {boolean=} opt_interpolate Interpolate. * @param {boolean=} opt_interpolate Interpolate.
* @return {ol.Coordinate} Coordinate. * @return {ol.Coordinate} Coordinate.
* @todo api * @api
*/ */
ol.geom.MultiLineString.prototype.getCoordinateAtM = ol.geom.MultiLineString.prototype.getCoordinateAtM =
function(m, opt_extrapolate, opt_interpolate) { function(m, opt_extrapolate, opt_interpolate) {
@@ -140,7 +140,7 @@ ol.geom.MultiLineString.prototype.getCoordinateAtM =
/** /**
* @return {ol.geom.RawMultiLineString} Coordinates. * @return {ol.geom.RawMultiLineString} Coordinates.
* @todo api * @api
*/ */
ol.geom.MultiLineString.prototype.getCoordinates = function() { ol.geom.MultiLineString.prototype.getCoordinates = function() {
return ol.geom.flat.inflate.coordinatess( return ol.geom.flat.inflate.coordinatess(
@@ -159,7 +159,7 @@ ol.geom.MultiLineString.prototype.getEnds = function() {
/** /**
* @param {number} index Index. * @param {number} index Index.
* @return {ol.geom.LineString} LineString. * @return {ol.geom.LineString} LineString.
* @todo api * @api
*/ */
ol.geom.MultiLineString.prototype.getLineString = function(index) { ol.geom.MultiLineString.prototype.getLineString = function(index) {
goog.asserts.assert(0 <= index && index < this.ends_.length); goog.asserts.assert(0 <= index && index < this.ends_.length);
@@ -175,7 +175,7 @@ ol.geom.MultiLineString.prototype.getLineString = function(index) {
/** /**
* @return {Array.<ol.geom.LineString>} LineStrings. * @return {Array.<ol.geom.LineString>} LineStrings.
* @todo api * @api
*/ */
ol.geom.MultiLineString.prototype.getLineStrings = function() { ol.geom.MultiLineString.prototype.getLineStrings = function() {
var flatCoordinates = this.flatCoordinates; var flatCoordinates = this.flatCoordinates;
@@ -236,7 +236,7 @@ ol.geom.MultiLineString.prototype.getSimplifiedGeometryInternal =
/** /**
* @inheritDoc * @inheritDoc
* @todo api * @api
*/ */
ol.geom.MultiLineString.prototype.getType = function() { ol.geom.MultiLineString.prototype.getType = function() {
return ol.geom.GeometryType.MULTI_LINE_STRING; return ol.geom.GeometryType.MULTI_LINE_STRING;
@@ -246,7 +246,7 @@ ol.geom.MultiLineString.prototype.getType = function() {
/** /**
* @param {ol.geom.RawMultiLineString} coordinates Coordinates. * @param {ol.geom.RawMultiLineString} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout. * @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo api * @api
*/ */
ol.geom.MultiLineString.prototype.setCoordinates = ol.geom.MultiLineString.prototype.setCoordinates =
function(coordinates, opt_layout) { function(coordinates, opt_layout) {

16
src/ol/geom/multipoint.js
View File

@@ -20,7 +20,7 @@ goog.require('ol.math');
* @extends {ol.geom.SimpleGeometry} * @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawMultiPoint} coordinates Coordinates. * @param {ol.geom.RawMultiPoint} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout. * @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo api * @api
*/ */
ol.geom.MultiPoint = function(coordinates, opt_layout) { ol.geom.MultiPoint = function(coordinates, opt_layout) {
goog.base(this); goog.base(this);
@@ -32,7 +32,7 @@ goog.inherits(ol.geom.MultiPoint, ol.geom.SimpleGeometry);
/** /**
* @param {ol.geom.Point} point Point. * @param {ol.geom.Point} point Point.
* @todo api * @api
*/ */
ol.geom.MultiPoint.prototype.appendPoint = function(point) { ol.geom.MultiPoint.prototype.appendPoint = function(point) {
goog.asserts.assert(point.getLayout() == this.layout); goog.asserts.assert(point.getLayout() == this.layout);
@@ -47,7 +47,7 @@ ol.geom.MultiPoint.prototype.appendPoint = function(point) {
/** /**
* @inheritDoc * @inheritDoc
* @todo api * @api
*/ */
ol.geom.MultiPoint.prototype.clone = function() { ol.geom.MultiPoint.prototype.clone = function() {
var multiPoint = new ol.geom.MultiPoint(null); var multiPoint = new ol.geom.MultiPoint(null);
@@ -85,7 +85,7 @@ ol.geom.MultiPoint.prototype.closestPointXY =
/** /**
* @return {ol.geom.RawMultiPoint} Coordinates. * @return {ol.geom.RawMultiPoint} Coordinates.
* @todo api * @api
*/ */
ol.geom.MultiPoint.prototype.getCoordinates = function() { ol.geom.MultiPoint.prototype.getCoordinates = function() {
return ol.geom.flat.inflate.coordinates( return ol.geom.flat.inflate.coordinates(
@@ -96,7 +96,7 @@ ol.geom.MultiPoint.prototype.getCoordinates = function() {
/** /**
* @param {number} index Index. * @param {number} index Index.
* @return {ol.geom.Point} Point. * @return {ol.geom.Point} Point.
* @todo api * @api
*/ */
ol.geom.MultiPoint.prototype.getPoint = function(index) { ol.geom.MultiPoint.prototype.getPoint = function(index) {
var n = goog.isNull(this.flatCoordinates) ? var n = goog.isNull(this.flatCoordinates) ?
@@ -114,7 +114,7 @@ ol.geom.MultiPoint.prototype.getPoint = function(index) {
/** /**
* @return {Array.<ol.geom.Point>} Points. * @return {Array.<ol.geom.Point>} Points.
* @todo api * @api
*/ */
ol.geom.MultiPoint.prototype.getPoints = function() { ol.geom.MultiPoint.prototype.getPoints = function() {
var flatCoordinates = this.flatCoordinates; var flatCoordinates = this.flatCoordinates;
@@ -134,7 +134,7 @@ ol.geom.MultiPoint.prototype.getPoints = function() {
/** /**
* @inheritDoc * @inheritDoc
* @todo api * @api
*/ */
ol.geom.MultiPoint.prototype.getType = function() { ol.geom.MultiPoint.prototype.getType = function() {
return ol.geom.GeometryType.MULTI_POINT; return ol.geom.GeometryType.MULTI_POINT;
@@ -144,7 +144,7 @@ ol.geom.MultiPoint.prototype.getType = function() {
/** /**
* @param {ol.geom.RawMultiPoint} coordinates Coordinates. * @param {ol.geom.RawMultiPoint} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout. * @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo api * @api
*/ */
ol.geom.MultiPoint.prototype.setCoordinates = ol.geom.MultiPoint.prototype.setCoordinates =
function(coordinates, opt_layout) { function(coordinates, opt_layout) {

20
src/ol/geom/multipolygon.js
View File

@@ -27,7 +27,7 @@ goog.require('ol.geom.flat.simplify');
* @extends {ol.geom.SimpleGeometry} * @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawMultiPolygon} coordinates Coordinates. * @param {ol.geom.RawMultiPolygon} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout. * @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo api * @api
*/ */
ol.geom.MultiPolygon = function(coordinates, opt_layout) { ol.geom.MultiPolygon = function(coordinates, opt_layout) {
@@ -84,7 +84,7 @@ goog.inherits(ol.geom.MultiPolygon, ol.geom.SimpleGeometry);
/** /**
* @param {ol.geom.Polygon} polygon Polygon. * @param {ol.geom.Polygon} polygon Polygon.
* @todo api * @api
*/ */
ol.geom.MultiPolygon.prototype.appendPolygon = function(polygon) { ol.geom.MultiPolygon.prototype.appendPolygon = function(polygon) {
goog.asserts.assert(polygon.getLayout() == this.layout); goog.asserts.assert(polygon.getLayout() == this.layout);
@@ -110,7 +110,7 @@ ol.geom.MultiPolygon.prototype.appendPolygon = function(polygon) {
/** /**
* @inheritDoc * @inheritDoc
* @todo api * @api
*/ */
ol.geom.MultiPolygon.prototype.clone = function() { ol.geom.MultiPolygon.prototype.clone = function() {
var multiPolygon = new ol.geom.MultiPolygon(null); var multiPolygon = new ol.geom.MultiPolygon(null);
@@ -151,7 +151,7 @@ ol.geom.MultiPolygon.prototype.containsXY = function(x, y) {
/** /**
* @return {number} Area. * @return {number} Area.
* @todo api * @api
*/ */
ol.geom.MultiPolygon.prototype.getArea = function() { ol.geom.MultiPolygon.prototype.getArea = function() {
return ol.geom.flat.area.linearRingss( return ol.geom.flat.area.linearRingss(
@@ -161,7 +161,7 @@ ol.geom.MultiPolygon.prototype.getArea = function() {
/** /**
* @return {ol.geom.RawMultiPolygon} Coordinates. * @return {ol.geom.RawMultiPolygon} Coordinates.
* @todo api * @api
*/ */
ol.geom.MultiPolygon.prototype.getCoordinates = function() { ol.geom.MultiPolygon.prototype.getCoordinates = function() {
return ol.geom.flat.inflate.coordinatesss( return ol.geom.flat.inflate.coordinatesss(
@@ -195,7 +195,7 @@ ol.geom.MultiPolygon.prototype.getFlatInteriorPoints = function() {
/** /**
* @return {ol.geom.MultiPoint} Interior points. * @return {ol.geom.MultiPoint} Interior points.
* @todo api * @api
*/ */
ol.geom.MultiPolygon.prototype.getInteriorPoints = function() { ol.geom.MultiPolygon.prototype.getInteriorPoints = function() {
var interiorPoints = new ol.geom.MultiPoint(null); var interiorPoints = new ol.geom.MultiPoint(null);
@@ -247,7 +247,7 @@ ol.geom.MultiPolygon.prototype.getSimplifiedGeometryInternal =
/** /**
* @param {number} index Index. * @param {number} index Index.
* @return {ol.geom.Polygon} Polygon. * @return {ol.geom.Polygon} Polygon.
* @todo api * @api
*/ */
ol.geom.MultiPolygon.prototype.getPolygon = function(index) { ol.geom.MultiPolygon.prototype.getPolygon = function(index) {
goog.asserts.assert(0 <= index && index < this.endss_.length); goog.asserts.assert(0 <= index && index < this.endss_.length);
@@ -278,7 +278,7 @@ ol.geom.MultiPolygon.prototype.getPolygon = function(index) {
/** /**
* @return {Array.<ol.geom.Polygon>} Polygons. * @return {Array.<ol.geom.Polygon>} Polygons.
* @todo api * @api
*/ */
ol.geom.MultiPolygon.prototype.getPolygons = function() { ol.geom.MultiPolygon.prototype.getPolygons = function() {
var layout = this.layout; var layout = this.layout;
@@ -307,7 +307,7 @@ ol.geom.MultiPolygon.prototype.getPolygons = function() {
/** /**
* @inheritDoc * @inheritDoc
* @todo api * @api
*/ */
ol.geom.MultiPolygon.prototype.getType = function() { ol.geom.MultiPolygon.prototype.getType = function() {
return ol.geom.GeometryType.MULTI_POLYGON; return ol.geom.GeometryType.MULTI_POLYGON;
@@ -317,7 +317,7 @@ ol.geom.MultiPolygon.prototype.getType = function() {
/** /**
* @param {ol.geom.RawMultiPolygon} coordinates Coordinates. * @param {ol.geom.RawMultiPolygon} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout. * @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo api * @api
*/ */
ol.geom.MultiPolygon.prototype.setCoordinates = ol.geom.MultiPolygon.prototype.setCoordinates =
function(coordinates, opt_layout) { function(coordinates, opt_layout) {

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

@@ -17,7 +17,7 @@ goog.require('ol.math');
* @extends {ol.geom.SimpleGeometry} * @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawPoint} coordinates Coordinates. * @param {ol.geom.RawPoint} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout. * @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo api * @api
*/ */
ol.geom.Point = function(coordinates, opt_layout) { ol.geom.Point = function(coordinates, opt_layout) {
goog.base(this); goog.base(this);
@@ -29,7 +29,7 @@ goog.inherits(ol.geom.Point, ol.geom.SimpleGeometry);
/** /**
* @inheritDoc * @inheritDoc
* @todo api * @api
*/ */
ol.geom.Point.prototype.clone = function() { ol.geom.Point.prototype.clone = function() {
var point = new ol.geom.Point(null); var point = new ol.geom.Point(null);
@@ -62,7 +62,7 @@ ol.geom.Point.prototype.closestPointXY =
/** /**
* @return {ol.geom.RawPoint} Coordinates. * @return {ol.geom.RawPoint} Coordinates.
* @todo api * @api
*/ */
ol.geom.Point.prototype.getCoordinates = function() { ol.geom.Point.prototype.getCoordinates = function() {
return this.flatCoordinates.slice(); return this.flatCoordinates.slice();
@@ -85,7 +85,7 @@ ol.geom.Point.prototype.getExtent = function(opt_extent) {
/** /**
* @inheritDoc * @inheritDoc
* @todo api * @api
*/ */
ol.geom.Point.prototype.getType = function() { ol.geom.Point.prototype.getType = function() {
return ol.geom.GeometryType.POINT; return ol.geom.GeometryType.POINT;
@@ -95,7 +95,7 @@ ol.geom.Point.prototype.getType = function() {
/** /**
* @param {ol.geom.RawPoint} coordinates Coordinates. * @param {ol.geom.RawPoint} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout. * @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo api * @api
*/ */
ol.geom.Point.prototype.setCoordinates = function(coordinates, opt_layout) { ol.geom.Point.prototype.setCoordinates = function(coordinates, opt_layout) {
if (goog.isNull(coordinates)) { if (goog.isNull(coordinates)) {

22
src/ol/geom/polygon.js
View File

@@ -27,7 +27,7 @@ goog.require('ol.geom.flat.simplify');
* @extends {ol.geom.SimpleGeometry} * @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawPolygon} coordinates Coordinates. * @param {ol.geom.RawPolygon} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout. * @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo api * @api
*/ */
ol.geom.Polygon = function(coordinates, opt_layout) { ol.geom.Polygon = function(coordinates, opt_layout) {
@@ -84,7 +84,7 @@ goog.inherits(ol.geom.Polygon, ol.geom.SimpleGeometry);
/** /**
* @param {ol.geom.LinearRing} linearRing Linear ring. * @param {ol.geom.LinearRing} linearRing Linear ring.
* @todo api * @api
*/ */
ol.geom.Polygon.prototype.appendLinearRing = function(linearRing) { ol.geom.Polygon.prototype.appendLinearRing = function(linearRing) {
goog.asserts.assert(linearRing.getLayout() == this.layout); goog.asserts.assert(linearRing.getLayout() == this.layout);
@@ -100,7 +100,7 @@ ol.geom.Polygon.prototype.appendLinearRing = function(linearRing) {
/** /**
* @inheritDoc * @inheritDoc
* @todo api * @api
*/ */
ol.geom.Polygon.prototype.clone = function() { ol.geom.Polygon.prototype.clone = function() {
var polygon = new ol.geom.Polygon(null); var polygon = new ol.geom.Polygon(null);
@@ -141,7 +141,7 @@ ol.geom.Polygon.prototype.containsXY = function(x, y) {
/** /**
* @return {number} Area. * @return {number} Area.
* @todo api * @api
*/ */
ol.geom.Polygon.prototype.getArea = function() { ol.geom.Polygon.prototype.getArea = function() {
return ol.geom.flat.area.linearRings( return ol.geom.flat.area.linearRings(
@@ -151,7 +151,7 @@ ol.geom.Polygon.prototype.getArea = function() {
/** /**
* @return {ol.geom.RawPolygon} Coordinates. * @return {ol.geom.RawPolygon} Coordinates.
* @todo api * @api
*/ */
ol.geom.Polygon.prototype.getCoordinates = function() { ol.geom.Polygon.prototype.getCoordinates = function() {
return ol.geom.flat.inflate.coordinatess( return ol.geom.flat.inflate.coordinatess(
@@ -184,7 +184,7 @@ ol.geom.Polygon.prototype.getFlatInteriorPoint = function() {
/** /**
* @return {ol.geom.Point} Interior point. * @return {ol.geom.Point} Interior point.
* @todo api * @api
*/ */
ol.geom.Polygon.prototype.getInteriorPoint = function() { ol.geom.Polygon.prototype.getInteriorPoint = function() {
return new ol.geom.Point(this.getFlatInteriorPoint()); return new ol.geom.Point(this.getFlatInteriorPoint());
@@ -194,7 +194,7 @@ ol.geom.Polygon.prototype.getInteriorPoint = function() {
/** /**
* @param {number} index Index. * @param {number} index Index.
* @return {ol.geom.LinearRing} Linear ring. * @return {ol.geom.LinearRing} Linear ring.
* @todo api * @api
*/ */
ol.geom.Polygon.prototype.getLinearRing = function(index) { ol.geom.Polygon.prototype.getLinearRing = function(index) {
goog.asserts.assert(0 <= index && index < this.ends_.length); goog.asserts.assert(0 <= index && index < this.ends_.length);
@@ -210,7 +210,7 @@ ol.geom.Polygon.prototype.getLinearRing = function(index) {
/** /**
* @return {Array.<ol.geom.LinearRing>} Linear rings. * @return {Array.<ol.geom.LinearRing>} Linear rings.
* @todo api * @api
*/ */
ol.geom.Polygon.prototype.getLinearRings = function() { ol.geom.Polygon.prototype.getLinearRings = function() {
var layout = this.layout; var layout = this.layout;
@@ -271,7 +271,7 @@ ol.geom.Polygon.prototype.getSimplifiedGeometryInternal =
/** /**
* @inheritDoc * @inheritDoc
* @todo api * @api
*/ */
ol.geom.Polygon.prototype.getType = function() { ol.geom.Polygon.prototype.getType = function() {
return ol.geom.GeometryType.POLYGON; return ol.geom.GeometryType.POLYGON;
@@ -281,7 +281,7 @@ ol.geom.Polygon.prototype.getType = function() {
/** /**
* @param {ol.geom.RawPolygon} coordinates Coordinates. * @param {ol.geom.RawPolygon} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout. * @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo api * @api
*/ */
ol.geom.Polygon.prototype.setCoordinates = function(coordinates, opt_layout) { ol.geom.Polygon.prototype.setCoordinates = function(coordinates, opt_layout) {
if (goog.isNull(coordinates)) { if (goog.isNull(coordinates)) {
@@ -326,7 +326,7 @@ ol.geom.Polygon.prototype.setFlatCoordinates =
* @param {number} radius Radius. * @param {number} radius Radius.
* @param {number=} opt_n Optional number of points. Default is `32`. * @param {number=} opt_n Optional number of points. Default is `32`.
* @return {ol.geom.Polygon} Circle geometry. * @return {ol.geom.Polygon} Circle geometry.
* @todo api * @api
*/ */
ol.geom.Polygon.circular = function(sphere, center, radius, opt_n) { ol.geom.Polygon.circular = function(sphere, center, radius, opt_n) {
var n = goog.isDef(opt_n) ? opt_n : 32; var n = goog.isDef(opt_n) ? opt_n : 32;

12
src/ol/geom/simplegeometry.js
View File

@@ -16,7 +16,7 @@ goog.require('ol.geom.flat.transform');
* *
* @constructor * @constructor
* @extends {ol.geom.Geometry} * @extends {ol.geom.Geometry}
* @todo api * @api
*/ */
ol.geom.SimpleGeometry = function() { ol.geom.SimpleGeometry = function() {
@@ -90,7 +90,7 @@ ol.geom.SimpleGeometry.prototype.containsXY = goog.functions.FALSE;
/** /**
* @inheritDoc * @inheritDoc
* @todo api * @api
*/ */
ol.geom.SimpleGeometry.prototype.getExtent = function(opt_extent) { ol.geom.SimpleGeometry.prototype.getExtent = function(opt_extent) {
if (this.extentRevision != this.getRevision()) { if (this.extentRevision != this.getRevision()) {
@@ -106,7 +106,7 @@ ol.geom.SimpleGeometry.prototype.getExtent = function(opt_extent) {
/** /**
* @return {ol.Coordinate} First coordinate. * @return {ol.Coordinate} First coordinate.
* @todo api * @api
*/ */
ol.geom.SimpleGeometry.prototype.getFirstCoordinate = function() { ol.geom.SimpleGeometry.prototype.getFirstCoordinate = function() {
return this.flatCoordinates.slice(0, this.stride); return this.flatCoordinates.slice(0, this.stride);
@@ -123,7 +123,7 @@ ol.geom.SimpleGeometry.prototype.getFlatCoordinates = function() {
/** /**
* @return {ol.Coordinate} Last point. * @return {ol.Coordinate} Last point.
* @todo api * @api
*/ */
ol.geom.SimpleGeometry.prototype.getLastCoordinate = function() { ol.geom.SimpleGeometry.prototype.getLastCoordinate = function() {
return this.flatCoordinates.slice(this.flatCoordinates.length - this.stride); return this.flatCoordinates.slice(this.flatCoordinates.length - this.stride);
@@ -132,7 +132,7 @@ ol.geom.SimpleGeometry.prototype.getLastCoordinate = function() {
/** /**
* @return {ol.geom.GeometryLayout} Layout. * @return {ol.geom.GeometryLayout} Layout.
* @todo api * @api
*/ */
ol.geom.SimpleGeometry.prototype.getLayout = function() { ol.geom.SimpleGeometry.prototype.getLayout = function() {
return this.layout; return this.layout;
@@ -141,7 +141,7 @@ ol.geom.SimpleGeometry.prototype.getLayout = function() {
/** /**
* @inheritDoc * @inheritDoc
* @todo api * @api
*/ */
ol.geom.SimpleGeometry.prototype.getSimplifiedGeometry = ol.geom.SimpleGeometry.prototype.getSimplifiedGeometry =
function(squaredTolerance) { function(squaredTolerance) {

2
src/ol/imagetile.js
View File

@@ -67,7 +67,7 @@ goog.inherits(ol.ImageTile, ol.Tile);
/** /**
* @inheritDoc * @inheritDoc
* @todo api * @api
*/ */
ol.ImageTile.prototype.getImage = function(opt_context) { ol.ImageTile.prototype.getImage = function(opt_context) {
if (goog.isDef(opt_context)) { if (goog.isDef(opt_context)) {

2
src/ol/interaction/doubleclickzoominteraction.js
View File

@@ -14,7 +14,7 @@ goog.require('ol.interaction.Interaction');
* @constructor * @constructor
* @extends {ol.interaction.Interaction} * @extends {ol.interaction.Interaction}
* @param {olx.interaction.DoubleClickZoomOptions=} opt_options Options. * @param {olx.interaction.DoubleClickZoomOptions=} opt_options Options.
* @todo api stable * @api stable
*/ */
ol.interaction.DoubleClickZoom = function(opt_options) { ol.interaction.DoubleClickZoom = function(opt_options) {

10
src/ol/interaction/draganddropinteraction.js
View File

@@ -23,7 +23,7 @@ goog.require('ol.proj');
* @extends {ol.interaction.Interaction} * @extends {ol.interaction.Interaction}
* @fires ol.interaction.DragAndDropEvent * @fires ol.interaction.DragAndDropEvent
* @param {olx.interaction.DragAndDropOptions=} opt_options Options. * @param {olx.interaction.DragAndDropOptions=} opt_options Options.
* @todo api stable * @api stable
*/ */
ol.interaction.DragAndDrop = function(opt_options) { ol.interaction.DragAndDrop = function(opt_options) {
@@ -184,7 +184,7 @@ ol.interaction.DragAndDropEventType = {
/** /**
* Triggered when features are added * Triggered when features are added
* @event ol.interaction.DragAndDropEvent#addfeatures * @event ol.interaction.DragAndDropEvent#addfeatures
* @todo api stable * @api stable
*/ */
ADD_FEATURES: 'addfeatures' ADD_FEATURES: 'addfeatures'
}; };
@@ -208,19 +208,19 @@ ol.interaction.DragAndDropEvent =
/** /**
* @type {Array.<ol.Feature>|undefined} * @type {Array.<ol.Feature>|undefined}
* @todo api stable * @api stable
*/ */
this.features = opt_features; this.features = opt_features;
/** /**
* @type {File} * @type {File}
* @todo api stable * @api stable
*/ */
this.file = file; this.file = file;
/** /**
* @type {ol.proj.Projection|undefined} * @type {ol.proj.Projection|undefined}
* @todo api * @api
*/ */
this.projection = opt_projection; this.projection = opt_projection;

10
src/ol/interaction/dragboxinteraction.js
View File

@@ -28,13 +28,13 @@ ol.DragBoxEventType = {
/** /**
* Triggered upon drag box start. * Triggered upon drag box start.
* @event ol.DragBoxEvent#boxstart * @event ol.DragBoxEvent#boxstart
* @todo api stable * @api stable
*/ */
BOXSTART: 'boxstart', BOXSTART: 'boxstart',
/** /**
* Triggered upon drag box end. * Triggered upon drag box end.
* @event ol.DragBoxEvent#boxend * @event ol.DragBoxEvent#boxend
* @todo api stable * @api stable
*/ */
BOXEND: 'boxend' BOXEND: 'boxend'
}; };
@@ -58,7 +58,7 @@ ol.DragBoxEvent = function(type, coordinate) {
* The coordinate of the drag event. * The coordinate of the drag event.
* @const * @const
* @type {ol.Coordinate} * @type {ol.Coordinate}
* @todo api stable * @api stable
*/ */
this.coordinate = coordinate; this.coordinate = coordinate;
@@ -79,7 +79,7 @@ goog.inherits(ol.DragBoxEvent, goog.events.Event);
* @extends {ol.interaction.Pointer} * @extends {ol.interaction.Pointer}
* @fires ol.DragBoxEvent * @fires ol.DragBoxEvent
* @param {olx.interaction.DragBoxOptions=} opt_options Options. * @param {olx.interaction.DragBoxOptions=} opt_options Options.
* @todo api stable * @api stable
*/ */
ol.interaction.DragBox = function(opt_options) { ol.interaction.DragBox = function(opt_options) {
@@ -131,7 +131,7 @@ ol.interaction.DragBox.prototype.handlePointerDrag = function(mapBrowserEvent) {
/** /**
* Returns geometry of last drawn box. * Returns geometry of last drawn box.
* @return {ol.geom.Geometry} Geometry. * @return {ol.geom.Geometry} Geometry.
* @todo api stable * @api stable
*/ */
ol.interaction.DragBox.prototype.getGeometry = function() { ol.interaction.DragBox.prototype.getGeometry = function() {
return this.box_.getGeometry(); return this.box_.getGeometry();

2
src/ol/interaction/dragpaninteraction.js
View File

@@ -18,7 +18,7 @@ goog.require('ol.interaction.Pointer');
* @constructor * @constructor
* @extends {ol.interaction.Pointer} * @extends {ol.interaction.Pointer}
* @param {olx.interaction.DragPanOptions=} opt_options Options. * @param {olx.interaction.DragPanOptions=} opt_options Options.
* @todo api stable * @api stable
*/ */
ol.interaction.DragPan = function(opt_options) { ol.interaction.DragPan = function(opt_options) {

2
src/ol/interaction/dragrotateandzoominteraction.js
View File

@@ -25,7 +25,7 @@ goog.require('ol.interaction.Pointer');
* @constructor * @constructor
* @extends {ol.interaction.Pointer} * @extends {ol.interaction.Pointer}
* @param {olx.interaction.DragRotateAndZoomOptions=} opt_options Options. * @param {olx.interaction.DragRotateAndZoomOptions=} opt_options Options.
* @todo api stable * @api stable
*/ */
ol.interaction.DragRotateAndZoom = function(opt_options) { ol.interaction.DragRotateAndZoom = function(opt_options) {

2
src/ol/interaction/dragrotateinteraction.js
View File

@@ -21,7 +21,7 @@ goog.require('ol.interaction.Pointer');
* @constructor * @constructor
* @extends {ol.interaction.Pointer} * @extends {ol.interaction.Pointer}
* @param {olx.interaction.DragRotateOptions=} opt_options Options. * @param {olx.interaction.DragRotateOptions=} opt_options Options.
* @todo api stable * @api stable
*/ */
ol.interaction.DragRotate = function(opt_options) { ol.interaction.DragRotate = function(opt_options) {

2
src/ol/interaction/dragzoominteraction.js
View File

@@ -20,7 +20,7 @@ goog.require('ol.style.Style');
* @constructor * @constructor
* @extends {ol.interaction.DragBox} * @extends {ol.interaction.DragBox}
* @param {olx.interaction.DragZoomOptions=} opt_options Options. * @param {olx.interaction.DragZoomOptions=} opt_options Options.
* @todo api stable * @api stable
*/ */
ol.interaction.DragZoom = function(opt_options) { ol.interaction.DragZoom = function(opt_options) {
var options = goog.isDef(opt_options) ? opt_options : {}; var options = goog.isDef(opt_options) ? opt_options : {};

8
src/ol/interaction/drawinteraction.js
View File

@@ -30,13 +30,13 @@ ol.DrawEventType = {
/** /**
* Triggered upon feature draw start * Triggered upon feature draw start
* @event ol.DrawEvent#drawstart * @event ol.DrawEvent#drawstart
* @todo api stable * @api stable
*/ */
DRAWSTART: 'drawstart', DRAWSTART: 'drawstart',
/** /**
* Triggered upon feature draw end * Triggered upon feature draw end
* @event ol.DrawEvent#drawend * @event ol.DrawEvent#drawend
* @todo api stable * @api stable
*/ */
DRAWEND: 'drawend' DRAWEND: 'drawend'
}; };
@@ -57,7 +57,7 @@ ol.DrawEvent = function(type, feature) {
/** /**
* The feature being drawn. * The feature being drawn.
* @type {ol.Feature} * @type {ol.Feature}
* @todo api stable * @api stable
*/ */
this.feature = feature; this.feature = feature;
@@ -74,7 +74,7 @@ goog.inherits(ol.DrawEvent, goog.events.Event);
* @extends {ol.interaction.Pointer} * @extends {ol.interaction.Pointer}
* @fires ol.DrawEvent * @fires ol.DrawEvent
* @param {olx.interaction.DrawOptions} options Options. * @param {olx.interaction.DrawOptions} options Options.
* @todo api stable * @api stable
*/ */
ol.interaction.Draw = function(options) { ol.interaction.Draw = function(options) {

2
src/ol/interaction/interactiondefaults.js
View File

@@ -35,7 +35,7 @@ goog.require('ol.interaction.PinchZoom');
* @param {olx.interaction.DefaultsOptions=} opt_options Defaults options. * @param {olx.interaction.DefaultsOptions=} opt_options Defaults options.
* @return {ol.Collection} A collection of interactions to be used with * @return {ol.Collection} A collection of interactions to be used with
* the ol.Map constructor's interactions option. * the ol.Map constructor's interactions option.
* @todo api stable * @api stable
*/ */
ol.interaction.defaults = function(opt_options) { ol.interaction.defaults = function(opt_options) {

2
src/ol/interaction/keyboardpaninteraction.js
View File

@@ -27,7 +27,7 @@ goog.require('ol.interaction.Interaction');
* @constructor * @constructor
* @extends {ol.interaction.Interaction} * @extends {ol.interaction.Interaction}
* @param {olx.interaction.KeyboardPanOptions=} opt_options Options. * @param {olx.interaction.KeyboardPanOptions=} opt_options Options.
* @todo api stable * @api stable
*/ */
ol.interaction.KeyboardPan = function(opt_options) { ol.interaction.KeyboardPan = function(opt_options) {

2
src/ol/interaction/keyboardzoominteraction.js
View File

@@ -23,7 +23,7 @@ goog.require('ol.interaction.Interaction');
* @constructor * @constructor
* @param {olx.interaction.KeyboardZoomOptions=} opt_options Options. * @param {olx.interaction.KeyboardZoomOptions=} opt_options Options.
* @extends {ol.interaction.Interaction} * @extends {ol.interaction.Interaction}
* @todo api stable * @api stable
*/ */
ol.interaction.KeyboardZoom = function(opt_options) { ol.interaction.KeyboardZoom = function(opt_options) {

2
src/ol/interaction/modifyinteraction.js
View File

@@ -43,7 +43,7 @@ ol.interaction.SegmentDataType;
* @constructor * @constructor
* @extends {ol.interaction.Pointer} * @extends {ol.interaction.Pointer}
* @param {olx.interaction.ModifyOptions} options Options. * @param {olx.interaction.ModifyOptions} options Options.
* @todo api stable * @api stable
*/ */
ol.interaction.Modify = function(options) { ol.interaction.Modify = function(options) {

2
src/ol/interaction/mousewheelzoominteraction.js
View File

@@ -17,7 +17,7 @@ goog.require('ol.interaction.Interaction');
* @constructor * @constructor
* @extends {ol.interaction.Interaction} * @extends {ol.interaction.Interaction}
* @param {olx.interaction.MouseWheelZoomOptions=} opt_options Options. * @param {olx.interaction.MouseWheelZoomOptions=} opt_options Options.
* @todo api stable * @api stable
*/ */
ol.interaction.MouseWheelZoom = function(opt_options) { ol.interaction.MouseWheelZoom = function(opt_options) {

2
src/ol/interaction/pinchrotateinteraction.js
View File

@@ -18,7 +18,7 @@ goog.require('ol.interaction.Pointer');
* @constructor * @constructor
* @extends {ol.interaction.Pointer} * @extends {ol.interaction.Pointer}
* @param {olx.interaction.PinchRotateOptions=} opt_options Options. * @param {olx.interaction.PinchRotateOptions=} opt_options Options.
* @todo api stable * @api stable
*/ */
ol.interaction.PinchRotate = function(opt_options) { ol.interaction.PinchRotate = function(opt_options) {

2
src/ol/interaction/pinchzoominteraction.js
View File

@@ -17,7 +17,7 @@ goog.require('ol.interaction.Pointer');
* @constructor * @constructor
* @extends {ol.interaction.Pointer} * @extends {ol.interaction.Pointer}
* @param {olx.interaction.PinchZoomOptions=} opt_options Options. * @param {olx.interaction.PinchZoomOptions=} opt_options Options.
* @todo api stable * @api stable
*/ */
ol.interaction.PinchZoom = function(opt_options) { ol.interaction.PinchZoom = function(opt_options) {

6
src/ol/interaction/selectinteraction.js
View File

@@ -24,7 +24,7 @@ goog.require('ol.interaction.Interaction');
* @constructor * @constructor
* @extends {ol.interaction.Interaction} * @extends {ol.interaction.Interaction}
* @param {olx.interaction.SelectOptions=} opt_options Options. * @param {olx.interaction.SelectOptions=} opt_options Options.
* @todo api stable * @api stable
*/ */
ol.interaction.Select = function(opt_options) { ol.interaction.Select = function(opt_options) {
@@ -107,7 +107,7 @@ goog.inherits(ol.interaction.Select, ol.interaction.Interaction);
/** /**
* Get the selected features. * Get the selected features.
* @return {ol.Collection} Features collection. * @return {ol.Collection} Features collection.
* @todo api stable * @api stable
*/ */
ol.interaction.Select.prototype.getFeatures = function() { ol.interaction.Select.prototype.getFeatures = function() {
return this.featureOverlay_.getFeatures(); return this.featureOverlay_.getFeatures();
@@ -187,7 +187,7 @@ ol.interaction.Select.prototype.handleMapBrowserEvent =
* Remove the interaction from its current map, if any, and attach it to a new * Remove the interaction from its current map, if any, and attach it to a new
* map, if any. Pass `null` to just remove the interaction from the current map. * map, if any. Pass `null` to just remove the interaction from the current map.
* @param {ol.Map} map Map. * @param {ol.Map} map Map.
* @todo api stable * @api stable
*/ */
ol.interaction.Select.prototype.setMap = function(map) { ol.interaction.Select.prototype.setMap = function(map) {
var currentMap = this.getMap(); var currentMap = this.getMap();

2
src/ol/kinetic.js
View File

@@ -13,7 +13,7 @@ goog.require('ol.animation');
* @param {number} delay Delay to consider to calculate the kinetic * @param {number} delay Delay to consider to calculate the kinetic
* initial values (milliseconds). * initial values (milliseconds).
* @struct * @struct
* @todo api * @api
*/ */
ol.Kinetic = function(decay, minVelocity, delay) { ol.Kinetic = function(decay, minVelocity, delay) {

2
src/ol/layer/heatmaplayer.js
View File

@@ -28,7 +28,7 @@ ol.layer.HeatmapLayerProperty = {
* @extends {ol.layer.Vector} * @extends {ol.layer.Vector}
* @fires ol.render.Event * @fires ol.render.Event
* @param {olx.layer.HeatmapOptions=} opt_options Options. * @param {olx.layer.HeatmapOptions=} opt_options Options.
* @todo api * @api
*/ */
ol.layer.Heatmap = function(opt_options) { ol.layer.Heatmap = function(opt_options) {
var options = goog.isDef(opt_options) ? opt_options : {}; var options = goog.isDef(opt_options) ? opt_options : {};

2
src/ol/layer/imagelayer.js
View File

@@ -13,7 +13,7 @@ goog.require('ol.layer.Layer');
* @extends {ol.layer.Layer} * @extends {ol.layer.Layer}
* @fires ol.render.Event * @fires ol.render.Event
* @param {olx.layer.LayerOptions} options Layer options. * @param {olx.layer.LayerOptions} options Layer options.
* @todo api * @api
*/ */
ol.layer.Image = function(options) { ol.layer.Image = function(options) {
goog.base(this, options); goog.base(this, options);

4
src/ol/layer/layer.js
View File

@@ -22,7 +22,7 @@ goog.require('ol.source.Source');
* @fires ol.render.Event * @fires ol.render.Event
* @fires change Triggered when the state of the source changes. * @fires change Triggered when the state of the source changes.
* @param {olx.layer.LayerOptions} options Layer options. * @param {olx.layer.LayerOptions} options Layer options.
* @todo api * @api
*/ */
ol.layer.Layer = function(options) { ol.layer.Layer = function(options) {
@@ -80,7 +80,7 @@ ol.layer.Layer.prototype.getLayerStatesArray = function(opt_states) {
/** /**
* @return {ol.source.Source} Source. * @return {ol.source.Source} Source.
* @todo api * @api
*/ */
ol.layer.Layer.prototype.getSource = function() { ol.layer.Layer.prototype.getSource = function() {
return this.source_; return this.source_;

32
src/ol/layer/layerbase.js
View File

@@ -86,7 +86,7 @@ goog.inherits(ol.layer.Base, ol.Object);
/** /**
* @return {number|undefined} The brightness of the layer. * @return {number|undefined} The brightness of the layer.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.layer.Base.prototype.getBrightness = function() { ol.layer.Base.prototype.getBrightness = function() {
return /** @type {number|undefined} */ ( return /** @type {number|undefined} */ (
@@ -101,7 +101,7 @@ goog.exportProperty(
/** /**
* @return {number|undefined} The contrast of the layer. * @return {number|undefined} The contrast of the layer.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.layer.Base.prototype.getContrast = function() { ol.layer.Base.prototype.getContrast = function() {
return /** @type {number|undefined} */ ( return /** @type {number|undefined} */ (
@@ -116,7 +116,7 @@ goog.exportProperty(
/** /**
* @return {number|undefined} The hue of the layer. * @return {number|undefined} The hue of the layer.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.layer.Base.prototype.getHue = function() { ol.layer.Base.prototype.getHue = function() {
return /** @type {number|undefined} */ (this.get(ol.layer.LayerProperty.HUE)); return /** @type {number|undefined} */ (this.get(ol.layer.LayerProperty.HUE));
@@ -174,7 +174,7 @@ ol.layer.Base.prototype.getLayerStatesArray = goog.abstractMethod;
/** /**
* @return {number|undefined} The maximum resolution of the layer. * @return {number|undefined} The maximum resolution of the layer.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.layer.Base.prototype.getMaxResolution = function() { ol.layer.Base.prototype.getMaxResolution = function() {
return /** @type {number|undefined} */ ( return /** @type {number|undefined} */ (
@@ -189,7 +189,7 @@ goog.exportProperty(
/** /**
* @return {number|undefined} The minimum resolution of the layer. * @return {number|undefined} The minimum resolution of the layer.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.layer.Base.prototype.getMinResolution = function() { ol.layer.Base.prototype.getMinResolution = function() {
return /** @type {number|undefined} */ ( return /** @type {number|undefined} */ (
@@ -204,7 +204,7 @@ goog.exportProperty(
/** /**
* @return {number|undefined} The opacity of the layer. * @return {number|undefined} The opacity of the layer.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.layer.Base.prototype.getOpacity = function() { ol.layer.Base.prototype.getOpacity = function() {
return /** @type {number|undefined} */ ( return /** @type {number|undefined} */ (
@@ -219,7 +219,7 @@ goog.exportProperty(
/** /**
* @return {number|undefined} The saturation of the layer. * @return {number|undefined} The saturation of the layer.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.layer.Base.prototype.getSaturation = function() { ol.layer.Base.prototype.getSaturation = function() {
return /** @type {number|undefined} */ ( return /** @type {number|undefined} */ (
@@ -240,7 +240,7 @@ ol.layer.Base.prototype.getSourceState = goog.abstractMethod;
/** /**
* @return {boolean|undefined} The visiblity of the layer. * @return {boolean|undefined} The visiblity of the layer.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.layer.Base.prototype.getVisible = function() { ol.layer.Base.prototype.getVisible = function() {
return /** @type {boolean|undefined} */ ( return /** @type {boolean|undefined} */ (
@@ -272,7 +272,7 @@ goog.exportProperty(
* *
* @param {number|undefined} brightness The brightness of the layer. * @param {number|undefined} brightness The brightness of the layer.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.layer.Base.prototype.setBrightness = function(brightness) { ol.layer.Base.prototype.setBrightness = function(brightness) {
this.set(ol.layer.LayerProperty.BRIGHTNESS, brightness); this.set(ol.layer.LayerProperty.BRIGHTNESS, brightness);
@@ -290,7 +290,7 @@ goog.exportProperty(
* *
* @param {number|undefined} contrast The contrast of the layer. * @param {number|undefined} contrast The contrast of the layer.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.layer.Base.prototype.setContrast = function(contrast) { ol.layer.Base.prototype.setContrast = function(contrast) {
this.set(ol.layer.LayerProperty.CONTRAST, contrast); this.set(ol.layer.LayerProperty.CONTRAST, contrast);
@@ -306,7 +306,7 @@ goog.exportProperty(
* unchanged. Other values are radians around the color circle. * unchanged. Other values are radians around the color circle.
* @param {number|undefined} hue The hue of the layer. * @param {number|undefined} hue The hue of the layer.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.layer.Base.prototype.setHue = function(hue) { ol.layer.Base.prototype.setHue = function(hue) {
this.set(ol.layer.LayerProperty.HUE, hue); this.set(ol.layer.LayerProperty.HUE, hue);
@@ -320,7 +320,7 @@ goog.exportProperty(
/** /**
* @param {number|undefined} maxResolution The maximum resolution of the layer. * @param {number|undefined} maxResolution The maximum resolution of the layer.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.layer.Base.prototype.setMaxResolution = function(maxResolution) { ol.layer.Base.prototype.setMaxResolution = function(maxResolution) {
this.set(ol.layer.LayerProperty.MAX_RESOLUTION, maxResolution); this.set(ol.layer.LayerProperty.MAX_RESOLUTION, maxResolution);
@@ -334,7 +334,7 @@ goog.exportProperty(
/** /**
* @param {number|undefined} minResolution The minimum resolution of the layer. * @param {number|undefined} minResolution The minimum resolution of the layer.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.layer.Base.prototype.setMinResolution = function(minResolution) { ol.layer.Base.prototype.setMinResolution = function(minResolution) {
this.set(ol.layer.LayerProperty.MIN_RESOLUTION, minResolution); this.set(ol.layer.LayerProperty.MIN_RESOLUTION, minResolution);
@@ -348,7 +348,7 @@ goog.exportProperty(
/** /**
* @param {number|undefined} opacity The opacity of the layer. * @param {number|undefined} opacity The opacity of the layer.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.layer.Base.prototype.setOpacity = function(opacity) { ol.layer.Base.prototype.setOpacity = function(opacity) {
this.set(ol.layer.LayerProperty.OPACITY, opacity); this.set(ol.layer.LayerProperty.OPACITY, opacity);
@@ -367,7 +367,7 @@ goog.exportProperty(
* *
* @param {number|undefined} saturation The saturation of the layer. * @param {number|undefined} saturation The saturation of the layer.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.layer.Base.prototype.setSaturation = function(saturation) { ol.layer.Base.prototype.setSaturation = function(saturation) {
this.set(ol.layer.LayerProperty.SATURATION, saturation); this.set(ol.layer.LayerProperty.SATURATION, saturation);
@@ -381,7 +381,7 @@ goog.exportProperty(
/** /**
* @param {boolean|undefined} visible The visiblity of the layer. * @param {boolean|undefined} visible The visiblity of the layer.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.layer.Base.prototype.setVisible = function(visible) { ol.layer.Base.prototype.setVisible = function(visible) {
this.set(ol.layer.LayerProperty.VISIBLE, visible); this.set(ol.layer.LayerProperty.VISIBLE, visible);

2
src/ol/layer/layergroup.js
View File

@@ -33,7 +33,7 @@ ol.layer.GroupProperty = {
* @fires change Triggered when the state of the source of any of the layers of * @fires change Triggered when the state of the source of any of the layers of
* this group changes * this group changes
* @param {olx.layer.GroupOptions=} opt_options Layer options. * @param {olx.layer.GroupOptions=} opt_options Layer options.
* @todo api * @api
*/ */
ol.layer.Group = function(opt_options) { ol.layer.Group = function(opt_options) {

2
src/ol/layer/tilelayer.js
View File

@@ -22,7 +22,7 @@ ol.layer.TileProperty = {
* @extends {ol.layer.Layer} * @extends {ol.layer.Layer}
* @fires ol.render.Event * @fires ol.render.Event
* @param {olx.layer.TileOptions} options Tile layer options. * @param {olx.layer.TileOptions} options Tile layer options.
* @todo api * @api
*/ */
ol.layer.Tile = function(options) { ol.layer.Tile = function(options) {
goog.base(this, options); goog.base(this, options);

8
src/ol/layer/vectorlayer.js
View File

@@ -22,7 +22,7 @@ ol.layer.VectorProperty = {
* @extends {ol.layer.Layer} * @extends {ol.layer.Layer}
* @fires ol.render.Event * @fires ol.render.Event
* @param {olx.layer.VectorOptions=} opt_options Options. * @param {olx.layer.VectorOptions=} opt_options Options.
* @todo api * @api
*/ */
ol.layer.Vector = function(opt_options) { ol.layer.Vector = function(opt_options) {
@@ -71,7 +71,7 @@ ol.layer.Vector.prototype.getRenderOrder = function() {
* option at construction or to the `setStyle` method. * option at construction or to the `setStyle` method.
* @return {ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction} * @return {ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction}
* Layer style. * Layer style.
* @todo api * @api
*/ */
ol.layer.Vector.prototype.getStyle = function() { ol.layer.Vector.prototype.getStyle = function() {
return this.style_; return this.style_;
@@ -81,7 +81,7 @@ ol.layer.Vector.prototype.getStyle = function() {
/** /**
* Get the style function. * Get the style function.
* @return {ol.feature.StyleFunction|undefined} Layer style function. * @return {ol.feature.StyleFunction|undefined} Layer style function.
* @todo api * @api
*/ */
ol.layer.Vector.prototype.getStyleFunction = function() { ol.layer.Vector.prototype.getStyleFunction = function() {
return this.styleFunction_; return this.styleFunction_;
@@ -103,7 +103,7 @@ ol.layer.Vector.prototype.setRenderOrder = function(renderOrder) {
* an array of styles. * an array of styles.
* @param {ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction} style * @param {ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction} style
* Layer style. * Layer style.
* @todo api * @api
*/ */
ol.layer.Vector.prototype.setStyle = function(style) { ol.layer.Vector.prototype.setStyle = function(style) {
this.style_ = style; this.style_ = style;

6
src/ol/loadingstrategy.js
View File

@@ -8,7 +8,7 @@ goog.require('ol.TileCoord');
* @param {ol.Extent} extent Extent. * @param {ol.Extent} extent Extent.
* @param {number} resolution Resolution. * @param {number} resolution Resolution.
* @return {Array.<ol.Extent>} Extents. * @return {Array.<ol.Extent>} Extents.
* @todo api * @api
*/ */
ol.loadingstrategy.all = function(extent, resolution) { ol.loadingstrategy.all = function(extent, resolution) {
return [[-Infinity, -Infinity, Infinity, Infinity]]; return [[-Infinity, -Infinity, Infinity, Infinity]];
@@ -21,7 +21,7 @@ ol.loadingstrategy.all = function(extent, resolution) {
* @param {ol.Extent} extent Extent. * @param {ol.Extent} extent Extent.
* @param {number} resolution Resolution. * @param {number} resolution Resolution.
* @return {Array.<ol.Extent>} Extents. * @return {Array.<ol.Extent>} Extents.
* @todo api * @api
*/ */
ol.loadingstrategy.bbox = function(extent, resolution) { ol.loadingstrategy.bbox = function(extent, resolution) {
return [extent]; return [extent];
@@ -32,7 +32,7 @@ ol.loadingstrategy.bbox = function(extent, resolution) {
* Creates a strategy function for loading features based on a tile grid. * Creates a strategy function for loading features based on a tile grid.
* @param {ol.tilegrid.TileGrid} tileGrid Tile grid. * @param {ol.tilegrid.TileGrid} tileGrid Tile grid.
* @return {function(ol.Extent, number): Array.<ol.Extent>} Loading strategy. * @return {function(ol.Extent, number): Array.<ol.Extent>} Loading strategy.
* @todo api * @api
*/ */
ol.loadingstrategy.createTile = function(tileGrid) { ol.loadingstrategy.createTile = function(tileGrid) {
return ( return (

62
src/ol/map.js
View File

@@ -146,7 +146,7 @@ ol.MapProperty = {
* @fires ol.MapEvent * @fires ol.MapEvent
* @fires ol.render.Event#postcompose * @fires ol.render.Event#postcompose
* @fires ol.render.Event#precompose * @fires ol.render.Event#precompose
* @todo api stable * @api stable
*/ */
ol.Map = function(options) { ol.Map = function(options) {
@@ -454,7 +454,7 @@ goog.inherits(ol.Map, ol.Object);
/** /**
* Add the given control to the map. * Add the given control to the map.
* @param {ol.control.Control} control Control. * @param {ol.control.Control} control Control.
* @todo api stable * @api stable
*/ */
ol.Map.prototype.addControl = function(control) { ol.Map.prototype.addControl = function(control) {
var controls = this.getControls(); var controls = this.getControls();
@@ -466,7 +466,7 @@ ol.Map.prototype.addControl = function(control) {
/** /**
* Add the given interaction to the map. * Add the given interaction to the map.
* @param {ol.interaction.Interaction} interaction Interaction to add. * @param {ol.interaction.Interaction} interaction Interaction to add.
* @todo api stable * @api stable
*/ */
ol.Map.prototype.addInteraction = function(interaction) { ol.Map.prototype.addInteraction = function(interaction) {
var interactions = this.getInteractions(); var interactions = this.getInteractions();
@@ -478,7 +478,7 @@ ol.Map.prototype.addInteraction = function(interaction) {
/** /**
* Adds the given layer to the top of this map. * Adds the given layer to the top of this map.
* @param {ol.layer.Base} layer Layer. * @param {ol.layer.Base} layer Layer.
* @todo api stable * @api stable
*/ */
ol.Map.prototype.addLayer = function(layer) { ol.Map.prototype.addLayer = function(layer) {
var layers = this.getLayerGroup().getLayers(); var layers = this.getLayerGroup().getLayers();
@@ -490,7 +490,7 @@ ol.Map.prototype.addLayer = function(layer) {
/** /**
* Add the given overlay to the map. * Add the given overlay to the map.
* @param {ol.Overlay} overlay Overlay. * @param {ol.Overlay} overlay Overlay.
* @todo api stable * @api stable
*/ */
ol.Map.prototype.addOverlay = function(overlay) { ol.Map.prototype.addOverlay = function(overlay) {
var overlays = this.getOverlays(); var overlays = this.getOverlays();
@@ -504,7 +504,7 @@ ol.Map.prototype.addOverlay = function(overlay) {
* animations before updating the map's view. The {@link ol.animation} * animations before updating the map's view. The {@link ol.animation}
* namespace provides several static methods for creating prerender functions. * namespace provides several static methods for creating prerender functions.
* @param {...ol.PreRenderFunction} var_args Any number of pre-render functions. * @param {...ol.PreRenderFunction} var_args Any number of pre-render functions.
* @todo api stable * @api stable
*/ */
ol.Map.prototype.beforeRender = function(var_args) { ol.Map.prototype.beforeRender = function(var_args) {
this.render(); this.render();
@@ -551,7 +551,7 @@ ol.Map.prototype.disposeInternal = function() {
* @return {T|undefined} Callback result, i.e. the return value of last * @return {T|undefined} Callback result, i.e. the return value of last
* callback execution, or the first truthy callback return value. * callback execution, or the first truthy callback return value.
* @template S,T,U * @template S,T,U
* @todo api stable * @api stable
*/ */
ol.Map.prototype.forEachFeatureAtPixel = ol.Map.prototype.forEachFeatureAtPixel =
function(pixel, callback, opt_this, opt_layerFilter, opt_this2) { function(pixel, callback, opt_this, opt_layerFilter, opt_this2) {
@@ -573,7 +573,7 @@ ol.Map.prototype.forEachFeatureAtPixel =
* Returns the geographical coordinate for a browser event. * Returns the geographical coordinate for a browser event.
* @param {Event} event Event. * @param {Event} event Event.
* @return {ol.Coordinate} Coordinate. * @return {ol.Coordinate} Coordinate.
* @todo api stable * @api stable
*/ */
ol.Map.prototype.getEventCoordinate = function(event) { ol.Map.prototype.getEventCoordinate = function(event) {
return this.getCoordinateFromPixel(this.getEventPixel(event)); return this.getCoordinateFromPixel(this.getEventPixel(event));
@@ -584,7 +584,7 @@ ol.Map.prototype.getEventCoordinate = function(event) {
* Returns the map pixel position for a browser event. * Returns the map pixel position for a browser event.
* @param {Event} event Event. * @param {Event} event Event.
* @return {ol.Pixel} Pixel. * @return {ol.Pixel} Pixel.
* @todo api stable * @api stable
*/ */
ol.Map.prototype.getEventPixel = function(event) { ol.Map.prototype.getEventPixel = function(event) {
// goog.style.getRelativePosition is based on event.targetTouches, // goog.style.getRelativePosition is based on event.targetTouches,
@@ -613,7 +613,7 @@ ol.Map.prototype.getEventPixel = function(event) {
* @return {Element|string|undefined} The Element or id of the Element that the * @return {Element|string|undefined} The Element or id of the Element that the
* map is rendered in. * map is rendered in.
* @todo observable * @todo observable
* @todo api stable * @api stable
*/ */
ol.Map.prototype.getTarget = function() { ol.Map.prototype.getTarget = function() {
return /** @type {Element|string|undefined} */ ( return /** @type {Element|string|undefined} */ (
@@ -628,7 +628,7 @@ goog.exportProperty(
/** /**
* @param {ol.Pixel} pixel Pixel. * @param {ol.Pixel} pixel Pixel.
* @return {ol.Coordinate} Coordinate. * @return {ol.Coordinate} Coordinate.
* @todo api stable * @api stable
*/ */
ol.Map.prototype.getCoordinateFromPixel = function(pixel) { ol.Map.prototype.getCoordinateFromPixel = function(pixel) {
var frameState = this.frameState_; var frameState = this.frameState_;
@@ -643,7 +643,7 @@ ol.Map.prototype.getCoordinateFromPixel = function(pixel) {
/** /**
* @return {ol.Collection} Controls. * @return {ol.Collection} Controls.
* @todo api stable * @api stable
*/ */
ol.Map.prototype.getControls = function() { ol.Map.prototype.getControls = function() {
return this.controls_; return this.controls_;
@@ -652,7 +652,7 @@ ol.Map.prototype.getControls = function() {
/** /**
* @return {ol.Collection} Overlays. * @return {ol.Collection} Overlays.
* @todo api stable * @api stable
*/ */
ol.Map.prototype.getOverlays = function() { ol.Map.prototype.getOverlays = function() {
return this.overlays_; return this.overlays_;
@@ -666,7 +666,7 @@ ol.Map.prototype.getOverlays = function() {
* *
* Interactions are used for e.g. pan, zoom and rotate. * Interactions are used for e.g. pan, zoom and rotate.
* @return {ol.Collection} {@link ol.interaction.Interaction Interactions}. * @return {ol.Collection} {@link ol.interaction.Interaction Interactions}.
* @todo api stable * @api stable
*/ */
ol.Map.prototype.getInteractions = function() { ol.Map.prototype.getInteractions = function() {
return this.interactions_; return this.interactions_;
@@ -677,7 +677,7 @@ ol.Map.prototype.getInteractions = function() {
* Get the layergroup associated with this map. * Get the layergroup associated with this map.
* @return {ol.layer.Group} A layer group containing the layers in this map. * @return {ol.layer.Group} A layer group containing the layers in this map.
* @todo observable * @todo observable
* @todo api stable * @api stable
*/ */
ol.Map.prototype.getLayerGroup = function() { ol.Map.prototype.getLayerGroup = function() {
return /** @type {ol.layer.Group} */ ( return /** @type {ol.layer.Group} */ (
@@ -692,7 +692,7 @@ goog.exportProperty(
/** /**
* Get the collection of layers associated with this map. * Get the collection of layers associated with this map.
* @return {ol.Collection|undefined} Layers. * @return {ol.Collection|undefined} Layers.
* @todo api stable * @api stable
*/ */
ol.Map.prototype.getLayers = function() { ol.Map.prototype.getLayers = function() {
var layerGroup = this.getLayerGroup(); var layerGroup = this.getLayerGroup();
@@ -707,7 +707,7 @@ ol.Map.prototype.getLayers = function() {
/** /**
* @param {ol.Coordinate} coordinate Coordinate. * @param {ol.Coordinate} coordinate Coordinate.
* @return {ol.Pixel} Pixel. * @return {ol.Pixel} Pixel.
* @todo api stable * @api stable
*/ */
ol.Map.prototype.getPixelFromCoordinate = function(coordinate) { ol.Map.prototype.getPixelFromCoordinate = function(coordinate) {
var frameState = this.frameState_; var frameState = this.frameState_;
@@ -733,7 +733,7 @@ ol.Map.prototype.getRenderer = function() {
* Get the size of this map. * Get the size of this map.
* @return {ol.Size|undefined} The size in pixels of the map in the DOM. * @return {ol.Size|undefined} The size in pixels of the map in the DOM.
* @todo observable * @todo observable
* @todo api stable * @api stable
*/ */
ol.Map.prototype.getSize = function() { ol.Map.prototype.getSize = function() {
return /** @type {ol.Size|undefined} */ (this.get(ol.MapProperty.SIZE)); return /** @type {ol.Size|undefined} */ (this.get(ol.MapProperty.SIZE));
@@ -749,7 +749,7 @@ goog.exportProperty(
* center and resolution. * center and resolution.
* @return {ol.View|undefined} The view that controls this map. * @return {ol.View|undefined} The view that controls this map.
* @todo observable * @todo observable
* @todo api stable * @api stable
*/ */
ol.Map.prototype.getView = function() { ol.Map.prototype.getView = function() {
return /** @type {ol.View} */ (this.get(ol.MapProperty.VIEW)); return /** @type {ol.View} */ (this.get(ol.MapProperty.VIEW));
@@ -762,7 +762,7 @@ goog.exportProperty(
/** /**
* @return {Element} Viewport. * @return {Element} Viewport.
* @todo api stable * @api stable
*/ */
ol.Map.prototype.getViewport = function() { ol.Map.prototype.getViewport = function() {
return this.viewport_; return this.viewport_;
@@ -1072,7 +1072,7 @@ ol.Map.prototype.isRendered = function() {
/** /**
* Requests an immediate render in a synchronous manner. * Requests an immediate render in a synchronous manner.
* @todo api stable * @api stable
*/ */
ol.Map.prototype.renderSync = function() { ol.Map.prototype.renderSync = function() {
this.animationDelay_.fire(); this.animationDelay_.fire();
@@ -1082,7 +1082,7 @@ ol.Map.prototype.renderSync = function() {
/** /**
* Requests a render frame; rendering will effectively occur at the next browser * Requests a render frame; rendering will effectively occur at the next browser
* animation frame. * animation frame.
* @todo api stable * @api stable
*/ */
ol.Map.prototype.render = function() { ol.Map.prototype.render = function() {
if (!this.animationDelay_.isActive()) { if (!this.animationDelay_.isActive()) {
@@ -1096,7 +1096,7 @@ ol.Map.prototype.render = function() {
* @param {ol.control.Control} control Control. * @param {ol.control.Control} control Control.
* @return {ol.control.Control|undefined} The removed control of undefined * @return {ol.control.Control|undefined} The removed control of undefined
* if the control was not found. * if the control was not found.
* @todo api stable * @api stable
*/ */
ol.Map.prototype.removeControl = function(control) { ol.Map.prototype.removeControl = function(control) {
var controls = this.getControls(); var controls = this.getControls();
@@ -1113,7 +1113,7 @@ ol.Map.prototype.removeControl = function(control) {
* @param {ol.interaction.Interaction} interaction Interaction to remove. * @param {ol.interaction.Interaction} interaction Interaction to remove.
* @return {ol.interaction.Interaction|undefined} The removed interaction (or * @return {ol.interaction.Interaction|undefined} The removed interaction (or
* undefined if the interaction was not found). * undefined if the interaction was not found).
* @todo api stable * @api stable
*/ */
ol.Map.prototype.removeInteraction = function(interaction) { ol.Map.prototype.removeInteraction = function(interaction) {
var removed; var removed;
@@ -1131,7 +1131,7 @@ ol.Map.prototype.removeInteraction = function(interaction) {
* @param {ol.layer.Base} layer Layer. * @param {ol.layer.Base} layer Layer.
* @return {ol.layer.Base|undefined} The removed layer or undefined if the * @return {ol.layer.Base|undefined} The removed layer or undefined if the
* layer was not found. * layer was not found.
* @todo api stable * @api stable
*/ */
ol.Map.prototype.removeLayer = function(layer) { ol.Map.prototype.removeLayer = function(layer) {
var layers = this.getLayerGroup().getLayers(); var layers = this.getLayerGroup().getLayers();
@@ -1145,7 +1145,7 @@ ol.Map.prototype.removeLayer = function(layer) {
* @param {ol.Overlay} overlay Overlay. * @param {ol.Overlay} overlay Overlay.
* @return {ol.Overlay|undefined} The removed overlay of undefined * @return {ol.Overlay|undefined} The removed overlay of undefined
* if the overlay was not found. * if the overlay was not found.
* @todo api stable * @api stable
*/ */
ol.Map.prototype.removeOverlay = function(overlay) { ol.Map.prototype.removeOverlay = function(overlay) {
var overlays = this.getOverlays(); var overlays = this.getOverlays();
@@ -1270,7 +1270,7 @@ ol.Map.prototype.renderFrame_ = function(time) {
* @param {ol.layer.Group} layerGroup A layer group containing the layers in * @param {ol.layer.Group} layerGroup A layer group containing the layers in
* this map. * this map.
* @todo observable * @todo observable
* @todo api stable * @api stable
*/ */
ol.Map.prototype.setLayerGroup = function(layerGroup) { ol.Map.prototype.setLayerGroup = function(layerGroup) {
this.set(ol.MapProperty.LAYERGROUP, layerGroup); this.set(ol.MapProperty.LAYERGROUP, layerGroup);
@@ -1285,7 +1285,7 @@ goog.exportProperty(
* Set the size of this map. * Set the size of this map.
* @param {ol.Size|undefined} size The size in pixels of the map in the DOM. * @param {ol.Size|undefined} size The size in pixels of the map in the DOM.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.Map.prototype.setSize = function(size) { ol.Map.prototype.setSize = function(size) {
this.set(ol.MapProperty.SIZE, size); this.set(ol.MapProperty.SIZE, size);
@@ -1301,7 +1301,7 @@ goog.exportProperty(
* @param {Element|string|undefined} target The Element or id of the Element * @param {Element|string|undefined} target The Element or id of the Element
* that the map is rendered in. * that the map is rendered in.
* @todo observable * @todo observable
* @todo api stable * @api stable
*/ */
ol.Map.prototype.setTarget = function(target) { ol.Map.prototype.setTarget = function(target) {
this.set(ol.MapProperty.TARGET, target); this.set(ol.MapProperty.TARGET, target);
@@ -1316,7 +1316,7 @@ goog.exportProperty(
* Set the view for this map. * Set the view for this map.
* @param {ol.View} view The view that controls this map. * @param {ol.View} view The view that controls this map.
* @todo observable * @todo observable
* @todo api stable * @api stable
*/ */
ol.Map.prototype.setView = function(view) { ol.Map.prototype.setView = function(view) {
this.set(ol.MapProperty.VIEW, view); this.set(ol.MapProperty.VIEW, view);
@@ -1340,7 +1340,7 @@ ol.Map.prototype.skipFeature = function(feature) {
/** /**
* Force a recalculation of the map viewport size. This should be called when * Force a recalculation of the map viewport size. This should be called when
* third-party code changes the size of the map viewport. * third-party code changes the size of the map viewport.
* @todo api stable * @api stable
*/ */
ol.Map.prototype.updateSize = function() { ol.Map.prototype.updateSize = function() {
var target = this.getTarget(); var target = this.getTarget();

20
src/ol/mapbrowserevent.js
View File

@@ -41,19 +41,19 @@ ol.MapBrowserEvent = function(type, map, browserEvent, opt_frameState) {
/** /**
* @const * @const
* @type {Event} * @type {Event}
* @todo api * @api
*/ */
this.originalEvent = browserEvent.getBrowserEvent(); this.originalEvent = browserEvent.getBrowserEvent();
/** /**
* @type {ol.Coordinate} * @type {ol.Coordinate}
* @todo api * @api
*/ */
this.coordinate = map.getEventCoordinate(this.originalEvent); this.coordinate = map.getEventCoordinate(this.originalEvent);
/** /**
* @type {ol.Pixel} * @type {ol.Pixel}
* @todo api * @api
*/ */
this.pixel = map.getEventPixel(this.originalEvent); this.pixel = map.getEventPixel(this.originalEvent);
@@ -65,7 +65,7 @@ goog.inherits(ol.MapBrowserEvent, ol.MapEvent);
* Prevents the default browser action. * Prevents the default browser action.
* @see https://developer.mozilla.org/en-US/docs/Web/API/event.preventDefault * @see https://developer.mozilla.org/en-US/docs/Web/API/event.preventDefault
* @override * @override
* @todo api * @api
*/ */
ol.MapBrowserEvent.prototype.preventDefault = function() { ol.MapBrowserEvent.prototype.preventDefault = function() {
goog.base(this, 'preventDefault'); goog.base(this, 'preventDefault');
@@ -77,7 +77,7 @@ ol.MapBrowserEvent.prototype.preventDefault = function() {
* Prevents further propagation of the current event. * Prevents further propagation of the current event.
* @see https://developer.mozilla.org/en-US/docs/Web/API/event.stopPropagation * @see https://developer.mozilla.org/en-US/docs/Web/API/event.stopPropagation
* @override * @override
* @todo api * @api
*/ */
ol.MapBrowserEvent.prototype.stopPropagation = function() { ol.MapBrowserEvent.prototype.stopPropagation = function() {
goog.base(this, 'stopPropagation'); goog.base(this, 'stopPropagation');
@@ -470,25 +470,25 @@ ol.MapBrowserEvent.EventType = {
* A true single click with no dragging and no double click. Note that this * A true single click with no dragging and no double click. Note that this
* event is delayed by 250 ms to ensure that it is not a double click. * event is delayed by 250 ms to ensure that it is not a double click.
* @event ol.MapBrowserEvent#singleclick * @event ol.MapBrowserEvent#singleclick
* @todo api * @api
*/ */
SINGLECLICK: 'singleclick', SINGLECLICK: 'singleclick',
/** /**
* A click with no dragging. A double click will fire two of this. * A click with no dragging. A double click will fire two of this.
* @event ol.MapBrowserEvent#click * @event ol.MapBrowserEvent#click
* @todo api * @api
*/ */
CLICK: goog.events.EventType.CLICK, CLICK: goog.events.EventType.CLICK,
/** /**
* A true double click, with no dragging. * A true double click, with no dragging.
* @event ol.MapBrowserEvent#dblclick * @event ol.MapBrowserEvent#dblclick
* @todo api * @api
*/ */
DBLCLICK: goog.events.EventType.DBLCLICK, DBLCLICK: goog.events.EventType.DBLCLICK,
/** /**
* Triggered when a pointer is dragged. * Triggered when a pointer is dragged.
* @event ol.MapBrowserEvent#pointerdrag * @event ol.MapBrowserEvent#pointerdrag
* @todo api * @api
*/ */
POINTERDRAG: 'pointerdrag', POINTERDRAG: 'pointerdrag',
@@ -497,7 +497,7 @@ ol.MapBrowserEvent.EventType = {
* Triggered when a pointer is moved. Note that on touch devices this is * Triggered when a pointer is moved. Note that on touch devices this is
* triggered when the map is panned, so is not the same as mousemove. * triggered when the map is panned, so is not the same as mousemove.
* @event ol.MapBrowserEvent#pointermove * @event ol.MapBrowserEvent#pointermove
* @todo api * @api
*/ */
POINTERMOVE: 'pointermove', POINTERMOVE: 'pointermove',
POINTERDOWN: 'pointerdown', POINTERDOWN: 'pointerdown',

8
src/ol/mapevent.js
View File

@@ -11,13 +11,13 @@ ol.MapEventType = {
/** /**
* Triggered after a map frame is rendered. * Triggered after a map frame is rendered.
* @event ol.MapEvent#postrender * @event ol.MapEvent#postrender
* @todo api * @api
*/ */
POSTRENDER: 'postrender', POSTRENDER: 'postrender',
/** /**
* Triggered after the map is moved. * Triggered after the map is moved.
* @event ol.MapEvent#moveend * @event ol.MapEvent#moveend
* @todo api * @api
*/ */
MOVEEND: 'moveend' MOVEEND: 'moveend'
}; };
@@ -39,14 +39,14 @@ ol.MapEvent = function(type, map, opt_frameState) {
/** /**
* The map where the event occurred. * The map where the event occurred.
* @type {ol.Map} * @type {ol.Map}
* @todo api * @api
*/ */
this.map = map; this.map = map;
/** /**
* The frame state at the time of the event. * The frame state at the time of the event.
* @type {?olx.FrameState} * @type {?olx.FrameState}
* @todo api * @api
*/ */
this.frameState = goog.isDef(opt_frameState) ? opt_frameState : null; this.frameState = goog.isDef(opt_frameState) ? opt_frameState : null;

24
src/ol/object.js
View File

@@ -22,13 +22,13 @@ ol.ObjectEventType = {
/** /**
* Triggered before a property is changed. * Triggered before a property is changed.
* @event ol.ObjectEvent#beforepropertychange * @event ol.ObjectEvent#beforepropertychange
* @todo api * @api
*/ */
BEFOREPROPERTYCHANGE: 'beforepropertychange', BEFOREPROPERTYCHANGE: 'beforepropertychange',
/** /**
* Triggered when a property is changed. * Triggered when a property is changed.
* @event ol.ObjectEvent#propertychange * @event ol.ObjectEvent#propertychange
* @todo api * @api
*/ */
PROPERTYCHANGE: 'propertychange' PROPERTYCHANGE: 'propertychange'
}; };
@@ -50,7 +50,7 @@ ol.ObjectEvent = function(type, key) {
/** /**
* The name of the property whose value is changing. * The name of the property whose value is changing.
* @type {string} * @type {string}
* @todo api * @api
*/ */
this.key = key; this.key = key;
@@ -132,7 +132,7 @@ ol.ObjectAccessor.prototype.transform = function(from, to) {
* @extends {ol.Observable} * @extends {ol.Observable}
* @param {Object.<string, *>=} opt_values Values. * @param {Object.<string, *>=} opt_values Values.
* @fires ol.ObjectEvent * @fires ol.ObjectEvent
* @todo api * @api
*/ */
ol.Object = function(opt_values) { ol.Object = function(opt_values) {
goog.base(this); goog.base(this);
@@ -266,7 +266,7 @@ ol.Object.getSetterName = function(key) {
* @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}
* @todo api * @api
*/ */
ol.Object.prototype.bindTo = function(key, target, opt_targetKey) { ol.Object.prototype.bindTo = function(key, target, opt_targetKey) {
var targetKey = opt_targetKey || key; var targetKey = opt_targetKey || key;
@@ -323,7 +323,7 @@ ol.Object.prototype.createBeforeChangeListener_ = function(key, targetKey) {
* Gets a value. * Gets a value.
* @param {string} key Key name. * @param {string} key Key name.
* @return {*} Value. * @return {*} Value.
* @todo api * @api
*/ */
ol.Object.prototype.get = function(key) { ol.Object.prototype.get = function(key) {
var value; var value;
@@ -351,7 +351,7 @@ ol.Object.prototype.get = function(key) {
/** /**
* Get a list of object property names. * Get a list of object property names.
* @return {Array.<string>} List of property names. * @return {Array.<string>} List of property names.
* @todo api * @api
*/ */
ol.Object.prototype.getKeys = function() { ol.Object.prototype.getKeys = function() {
var accessors = this.accessors_; var accessors = this.accessors_;
@@ -383,7 +383,7 @@ ol.Object.prototype.getKeys = function() {
/** /**
* Get an object of all property names and values. * Get an object of all property names and values.
* @return {Object.<string, *>} Object. * @return {Object.<string, *>} Object.
* @todo api * @api
*/ */
ol.Object.prototype.getProperties = function() { ol.Object.prototype.getProperties = function() {
var properties = {}; var properties = {};
@@ -413,7 +413,7 @@ ol.Object.prototype.notify = function(key) {
* Sets a value. * Sets a value.
* @param {string} key Key name. * @param {string} key Key name.
* @param {*} value Value. * @param {*} value Value.
* @todo api * @api
*/ */
ol.Object.prototype.set = function(key, value) { ol.Object.prototype.set = function(key, value) {
this.dispatchEvent( this.dispatchEvent(
@@ -442,7 +442,7 @@ ol.Object.prototype.set = function(key, value) {
/** /**
* Sets a collection of key-value pairs. * Sets a collection of key-value pairs.
* @param {Object.<string, *>} values Values. * @param {Object.<string, *>} values Values.
* @todo api * @api
*/ */
ol.Object.prototype.setProperties = function(values) { ol.Object.prototype.setProperties = function(values) {
var key; var key;
@@ -456,7 +456,7 @@ ol.Object.prototype.setProperties = 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 name. * @param {string} key Key name.
* @todo api * @api
*/ */
ol.Object.prototype.unbind = function(key) { ol.Object.prototype.unbind = function(key) {
var listeners = this.listeners_; var listeners = this.listeners_;
@@ -480,7 +480,7 @@ ol.Object.prototype.unbind = function(key) {
/** /**
* Removes all bindings. * Removes all bindings.
* @todo api * @api
*/ */
ol.Object.prototype.unbindAll = function() { ol.Object.prototype.unbindAll = function() {
for (var key in this.listeners_) { for (var key in this.listeners_) {

14
src/ol/observable.js
View File

@@ -18,7 +18,7 @@ goog.require('goog.events.EventType');
* @extends {goog.events.EventTarget} * @extends {goog.events.EventTarget}
* @suppress {checkStructDictInheritance} * @suppress {checkStructDictInheritance}
* @struct * @struct
* @todo api * @api
*/ */
ol.Observable = function() { ol.Observable = function() {
@@ -37,7 +37,7 @@ goog.inherits(ol.Observable, goog.events.EventTarget);
/** /**
* Dispatches a `change` event. * Dispatches a `change` event.
* @fires change * @fires change
* @todo api * @api
*/ */
ol.Observable.prototype.dispatchChangeEvent = function() { ol.Observable.prototype.dispatchChangeEvent = function() {
++this.revision_; ++this.revision_;
@@ -47,7 +47,7 @@ ol.Observable.prototype.dispatchChangeEvent = function() {
/** /**
* @return {number} Revision. * @return {number} Revision.
* @todo api * @api
*/ */
ol.Observable.prototype.getRevision = function() { ol.Observable.prototype.getRevision = function() {
return this.revision_; return this.revision_;
@@ -60,7 +60,7 @@ ol.Observable.prototype.getRevision = function() {
* @param {function(?): ?} listener The listener function. * @param {function(?): ?} listener The listener function.
* @param {Object=} opt_this The object to use as `this` in `listener`. * @param {Object=} opt_this The object to use as `this` in `listener`.
* @return {goog.events.Key} Unique key for the listener. * @return {goog.events.Key} Unique key for the listener.
* @todo api * @api
*/ */
ol.Observable.prototype.on = function(type, listener, opt_this) { ol.Observable.prototype.on = function(type, listener, opt_this) {
return goog.events.listen(this, type, listener, false, opt_this); return goog.events.listen(this, type, listener, false, opt_this);
@@ -73,7 +73,7 @@ ol.Observable.prototype.on = function(type, listener, opt_this) {
* @param {function(?): ?} listener The listener function. * @param {function(?): ?} listener The listener function.
* @param {Object=} opt_this The object to use as `this` in `listener`. * @param {Object=} opt_this The object to use as `this` in `listener`.
* @return {goog.events.Key} Unique key for the listener. * @return {goog.events.Key} Unique key for the listener.
* @todo api * @api
*/ */
ol.Observable.prototype.once = function(type, listener, opt_this) { ol.Observable.prototype.once = function(type, listener, opt_this) {
return goog.events.listenOnce(this, type, listener, false, opt_this); return goog.events.listenOnce(this, type, listener, false, opt_this);
@@ -85,7 +85,7 @@ ol.Observable.prototype.once = function(type, listener, opt_this) {
* @param {string|Array.<string>} type The event type or array of event types. * @param {string|Array.<string>} type The event type or array of event types.
* @param {function(?): ?} listener The listener function. * @param {function(?): ?} listener The listener function.
* @param {Object=} opt_this The object to use as `this` in `listener`. * @param {Object=} opt_this The object to use as `this` in `listener`.
* @todo api * @api
*/ */
ol.Observable.prototype.un = function(type, listener, opt_this) { ol.Observable.prototype.un = function(type, listener, opt_this) {
goog.events.unlisten(this, type, listener, false, opt_this); goog.events.unlisten(this, type, listener, false, opt_this);
@@ -95,7 +95,7 @@ ol.Observable.prototype.un = function(type, listener, opt_this) {
/** /**
* Removes an event listener using the key returned by `on()` or `once()`. * Removes an event listener using the key returned by `on()` or `once()`.
* @param {goog.events.Key} key Key. * @param {goog.events.Key} key Key.
* @todo api * @api
*/ */
ol.Observable.prototype.unByKey = function(key) { ol.Observable.prototype.unByKey = function(key) {
goog.events.unlistenByKey(key); goog.events.unlistenByKey(key);

2
src/ol/ol.js
View File

@@ -215,7 +215,7 @@ ol.ZOOMSLIDER_ANIMATION_DURATION = 200;
* linter complains with: * linter complains with:
* *
* "Missing newline between constructor and goog.inherits" * "Missing newline between constructor and goog.inherits"
* @todo api * @api
*/ */
ol.inherits = ol.inherits =
goog.inherits; goog.inherits;

24
src/ol/overlay.js
View File

@@ -30,7 +30,7 @@ ol.OverlayProperty = {
* `'center-left'`, `'center-center'`, `'center-right'`, `'top-left'`, * `'center-left'`, `'center-center'`, `'center-right'`, `'top-left'`,
* `'top-center'`, `'top-right'` * `'top-center'`, `'top-right'`
* @enum {string} * @enum {string}
* @todo api * @api
*/ */
ol.OverlayPositioning = { ol.OverlayPositioning = {
BOTTOM_LEFT: 'bottom-left', BOTTOM_LEFT: 'bottom-left',
@@ -64,7 +64,7 @@ ol.OverlayPositioning = {
* @constructor * @constructor
* @extends {ol.Object} * @extends {ol.Object}
* @param {olx.OverlayOptions} options Overlay options. * @param {olx.OverlayOptions} options Overlay options.
* @todo api stable * @api stable
*/ */
ol.Overlay = function(options) { ol.Overlay = function(options) {
@@ -155,7 +155,7 @@ goog.inherits(ol.Overlay, ol.Object);
* Get the DOM element of this overlay. * Get the DOM element of this overlay.
* @return {Element|undefined} The Element containing the overlay. * @return {Element|undefined} The Element containing the overlay.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.Overlay.prototype.getElement = function() { ol.Overlay.prototype.getElement = function() {
return /** @type {Element|undefined} */ ( return /** @type {Element|undefined} */ (
@@ -171,7 +171,7 @@ goog.exportProperty(
* Get the map associated with this overlay. * Get the map associated with this overlay.
* @return {ol.Map|undefined} The map that the overlay is part of. * @return {ol.Map|undefined} The map that the overlay is part of.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.Overlay.prototype.getMap = function() { ol.Overlay.prototype.getMap = function() {
return /** @type {ol.Map|undefined} */ ( return /** @type {ol.Map|undefined} */ (
@@ -187,7 +187,7 @@ goog.exportProperty(
* Get the offset of this overlay. * Get the offset of this overlay.
* @return {Array.<number>} The offset. * @return {Array.<number>} The offset.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.Overlay.prototype.getOffset = function() { ol.Overlay.prototype.getOffset = function() {
return /** @type {Array.<number>} */ ( return /** @type {Array.<number>} */ (
@@ -204,7 +204,7 @@ goog.exportProperty(
* @return {ol.Coordinate|undefined} The spatial point that the overlay is * @return {ol.Coordinate|undefined} The spatial point that the overlay is
* anchored at. * anchored at.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.Overlay.prototype.getPosition = function() { ol.Overlay.prototype.getPosition = function() {
return /** @type {ol.Coordinate|undefined} */ ( return /** @type {ol.Coordinate|undefined} */ (
@@ -221,7 +221,7 @@ goog.exportProperty(
* @return {ol.OverlayPositioning} How the overlay is positioned * @return {ol.OverlayPositioning} How the overlay is positioned
* relative to its point on the map. * relative to its point on the map.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.Overlay.prototype.getPositioning = function() { ol.Overlay.prototype.getPositioning = function() {
return /** @type {ol.OverlayPositioning} */ ( return /** @type {ol.OverlayPositioning} */ (
@@ -307,7 +307,7 @@ ol.Overlay.prototype.handlePositioningChanged = function() {
* Set the DOM element to be associated with this overlay. * Set the DOM element to be associated with this overlay.
* @param {Element|undefined} element The Element containing the overlay. * @param {Element|undefined} element The Element containing the overlay.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.Overlay.prototype.setElement = function(element) { ol.Overlay.prototype.setElement = function(element) {
this.set(ol.OverlayProperty.ELEMENT, element); this.set(ol.OverlayProperty.ELEMENT, element);
@@ -322,7 +322,7 @@ goog.exportProperty(
* Set the map to be associated with this overlay. * Set the map to be associated with this overlay.
* @param {ol.Map|undefined} map The map that the overlay is part of. * @param {ol.Map|undefined} map The map that the overlay is part of.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.Overlay.prototype.setMap = function(map) { ol.Overlay.prototype.setMap = function(map) {
this.set(ol.OverlayProperty.MAP, map); this.set(ol.OverlayProperty.MAP, map);
@@ -337,7 +337,7 @@ goog.exportProperty(
* Set the offset for this overlay. * Set the offset for this overlay.
* @param {Array.<number>} offset Offset. * @param {Array.<number>} offset Offset.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.Overlay.prototype.setOffset = function(offset) { ol.Overlay.prototype.setOffset = function(offset) {
this.set(ol.OverlayProperty.OFFSET, offset); this.set(ol.OverlayProperty.OFFSET, offset);
@@ -353,7 +353,7 @@ goog.exportProperty(
* @param {ol.Coordinate|undefined} position The spatial point that the overlay * @param {ol.Coordinate|undefined} position The spatial point that the overlay
* is anchored at. * is anchored at.
* @todo observable * @todo observable
* @todo api stable * @api stable
*/ */
ol.Overlay.prototype.setPosition = function(position) { ol.Overlay.prototype.setPosition = function(position) {
this.set(ol.OverlayProperty.POSITION, position); this.set(ol.OverlayProperty.POSITION, position);
@@ -369,7 +369,7 @@ goog.exportProperty(
* @param {ol.OverlayPositioning} positioning how the overlay is * @param {ol.OverlayPositioning} positioning how the overlay is
* positioned relative to its point on the map. * positioned relative to its point on the map.
* @todo observable * @todo observable
* @todo api * @api
*/ */
ol.Overlay.prototype.setPositioning = function(positioning) { ol.Overlay.prototype.setPositioning = function(positioning) {
this.set(ol.OverlayProperty.POSITIONING, positioning); this.set(ol.OverlayProperty.POSITIONING, positioning);

2
src/ol/pixel.js
View File

@@ -5,6 +5,6 @@ goog.provide('ol.Pixel');
* An array with two elements, representing a pixel. The first element is the * An array with two elements, representing a pixel. The first element is the
* x-coordinate, the second the y-coordinate of the pixel. * x-coordinate, the second the y-coordinate of the pixel.
* @typedef {Array.<number>} * @typedef {Array.<number>}
* @todo api * @api
*/ */
ol.Pixel; ol.Pixel;

6
src/ol/proj/chprojection.js
View File

@@ -17,7 +17,7 @@ goog.require('ol.proj.Units');
* @constructor * @constructor
* @extends {ol.proj.Projection} * @extends {ol.proj.Projection}
* @param {{code: string, extent: ol.Extent}} options Options. * @param {{code: string, extent: ol.Extent}} options Options.
* @todo api * @api
*/ */
ol.proj.CH = function(options) { ol.proj.CH = function(options) {
goog.base(this, { goog.base(this, {
@@ -396,7 +396,7 @@ ol.proj.CH.prototype.getPointResolution = function(resolution, point) {
* The EPSG:2056 projection, also known as LV95 (CH1903+). * The EPSG:2056 projection, also known as LV95 (CH1903+).
* @constructor * @constructor
* @extends {ol.proj.CH} * @extends {ol.proj.CH}
* @todo api * @api
*/ */
ol.proj.EPSG2056 = function() { ol.proj.EPSG2056 = function() {
goog.base(this, { goog.base(this, {
@@ -435,7 +435,7 @@ ol.proj.EPSG2056.add = function() {
* The EPSG:21781 projection, also known as LV03 (CH1903). * The EPSG:21781 projection, also known as LV03 (CH1903).
* @constructor * @constructor
* @extends {ol.proj.CH} * @extends {ol.proj.CH}
* @todo api * @api
*/ */
ol.proj.EPSG21781 = function() { ol.proj.EPSG21781 = function() {
goog.base(this, { goog.base(this, {

2
src/ol/proj/common.js
View File

@@ -7,7 +7,7 @@ goog.require('ol.proj.EPSG4326');
/** /**
* FIXME empty description for jsdoc * FIXME empty description for jsdoc
* @todo api * @api
*/ */
ol.proj.common.add = function() { ol.proj.common.add = function() {
// Add transformations that don't alter coordinates to convert within set of // Add transformations that don't alter coordinates to convert within set of

2
src/ol/proj/epsg3857projection.js
View File

@@ -16,7 +16,7 @@ goog.require('ol.proj.Units');
* @constructor * @constructor
* @extends {ol.proj.Projection} * @extends {ol.proj.Projection}
* @param {string} code Code. * @param {string} code Code.
* @todo api * @api
*/ */
ol.proj.EPSG3857 = function(code) { ol.proj.EPSG3857 = function(code) {
goog.base(this, { goog.base(this, {

Some files were not shown because too many files have changed in this diff Show More