diff --git a/apidoc/plugins/api.js b/apidoc/plugins/api.js index 6d653f993f..5761fd5a03 100644 --- a/apidoc/plugins/api.js +++ b/apidoc/plugins/api.js @@ -35,9 +35,6 @@ function hasApiMembers(doclet) { } function includeAugments(doclet) { - if (doclet.longname == 'ol.View2D') { - debugger - } var augments = doclet.augments; if (augments) { var cls; @@ -65,8 +62,10 @@ function includeAugments(doclet) { } }); } - cls._hideConstructor = true; - delete cls.undocumented; + if (cls.longname.indexOf('oli.') !== 0) { + cls._hideConstructor = true; + delete cls.undocumented; + } } } } diff --git a/externs/oli.js b/externs/oli.js index 1d3990a2ba..91ae1d9875 100644 --- a/externs/oli.js +++ b/externs/oli.js @@ -15,9 +15,7 @@ oli.CollectionEvent; /** - * The element that is added to or removed from the collection. * @type {*} - * @todo api */ oli.CollectionEvent.prototype.element; @@ -29,7 +27,6 @@ oli.DragBoxEvent; /** * @type {ol.Coordinate} - * @todo api */ oli.DragBoxEvent.prototype.coordinate; @@ -40,108 +37,12 @@ oli.DrawEvent; /** - * The feature being drawn. * @type {ol.Feature} - * @todo api */ oli.DrawEvent.prototype.feature; -/** @interface */ -oli.FrameState; - - -/** @type {boolean} */ -oli.FrameState.prototype.animate; - - -/** @type {Object.} */ -oli.FrameState.prototype.attributions; - - -/** @type {goog.vec.Mat4.Number} */ -oli.FrameState.prototype.coordinateToPixelMatrix; - - -/** @type {(null|ol.Extent)} */ -oli.FrameState.prototype.extent; - - -/** @type {ol.Coordinate} */ -oli.FrameState.prototype.focus; - - -/** @type {number} */ -oli.FrameState.prototype.index; - - -/** @type {Object.} */ -oli.FrameState.prototype.layerStates; - - -/** @type {Array.} */ -oli.FrameState.prototype.layerStatesArray; - - -/** @type {Object.} */ -oli.FrameState.prototype.logos; - - -/** - * @type {number} - * @todo api - */ -oli.FrameState.prototype.pixelRatio; - - -/** @type {goog.vec.Mat4.Number} */ -oli.FrameState.prototype.pixelToCoordinateMatrix; - - -/** @type {Array.} */ -oli.FrameState.prototype.postRenderFunctions; - - -/** @type {ol.Size} */ -oli.FrameState.prototype.size; - - -/** @type {Object.} */ -oli.FrameState.prototype.skippedFeatureUids_; - - -/** @type {ol.TileQueue} */ -oli.FrameState.prototype.tileQueue; - - -/** - * @type {number} - * @todo api - */ -oli.FrameState.prototype.time; - - -/** @type {Object.>} */ -oli.FrameState.prototype.usedTiles; - - -/** - * @type {oli.View2DState} - * @todo api - */ -oli.FrameState.prototype.view2DState; - - -/** @type {Array.} */ -oli.FrameState.prototype.viewHints; - - -/** @type {Object.>} */ -oli.FrameState.prototype.wantedTiles; - - - /** @interface */ oli.ObjectEvent; @@ -157,47 +58,23 @@ oli.MapBrowserEvent; /** * @type {ol.Coordinate} - * @todo api */ oli.MapBrowserEvent.prototype.coordinate; /** * @type {Event} - * @todo api */ oli.MapBrowserEvent.prototype.originalEvent; /** * @type {ol.Pixel} - * @todo api */ oli.MapBrowserEvent.prototype.pixel; -/** @interface */ -oli.View2DState; - - -/** @type {ol.Coordinate} */ -oli.View2DState.prototype.center; - - -/** @type {ol.proj.Projection} */ -oli.View2DState.prototype.projection; - - -/** @type {number} */ -oli.View2DState.prototype.resolution; - - -/** @type {number} */ -oli.View2DState.prototype.rotation; - - - /** * @interface */ @@ -218,21 +95,18 @@ oli.interaction.DragAndDropEvent; /** * @type {Array.|undefined} - * @todo api */ oli.interaction.DragAndDropEvent.prototype.features; /** * @type {ol.proj.Projection|undefined} - * @todo api */ oli.interaction.DragAndDropEvent.prototype.projection; /** * @type {File} - * @todo api */ oli.interaction.DragAndDropEvent.prototype.file; @@ -242,33 +116,25 @@ oli.render.Event; /** - * Canvas context. Only available when a Canvas renderer is used, null - * otherwise. * @type {CanvasRenderingContext2D|null|undefined} - * @todo api */ oli.render.Event.prototype.context; /** - * @type {oli.FrameState|undefined} - * @todo api + * @type {olx.FrameState|undefined} */ oli.render.Event.prototype.frameState; /** - * WebGL context. Only available when a WebGL renderer is used, null otherwise. * @type {ol.webgl.Context|null|undefined} - * @todo api */ oli.render.Event.prototype.glContext; /** - * For canvas, this is an instance of {@link ol.render.canvas.Immediate}. * @type {ol.render.IVectorContext|undefined} - * @todo api */ oli.render.Event.prototype.vectorContext; @@ -279,8 +145,6 @@ oli.source.VectorEvent; /** - * The feature being added or removed. * @type {ol.Feature} - * @todo api */ oli.source.VectorEvent.prototype.feature; diff --git a/externs/olx.js b/externs/olx.js index c642690383..2302efb277 100644 --- a/externs/olx.js +++ b/externs/olx.js @@ -4,6 +4,9 @@ var olx; +/* typedefs for object literals provided by applications */ + + /** * @typedef {{html: string, * tileRanges: (Object.>|undefined)}} @@ -4962,3 +4965,66 @@ olx.View2D.fitGeometryOptions.prototype.nearest; * @type {number|undefined} */ olx.View2D.fitGeometryOptions.prototype.minResolution; + + +/* typedefs for object literals exposed by the library */ + + +/** + * @typedef {{animate: boolean, + * attributions: Object., + * coordinateToPixelMatrix: goog.vec.Mat4.Number, + * extent: (null|ol.Extent), + * focus: ol.Coordinate, + * index: number, + * layerStates: Object., + * layerStatesArray: Array., + * logos: Object., + * pixelRatio: number, + * pixelToCoordinateMatrix: goog.vec.Mat4.Number, + * postRenderFunctions: Array., + * size: ol.Size, + * skippedFeatureUids_: Object., + * tileQueue: ol.TileQueue, + * time: number, + * usedTiles: Object.>, + * view2DState: olx.View2DState, + * viewHints: Array., + * wantedTiles: Object.>}} + * @todo api + */ +olx.FrameState; + + +/** @type {number} */ +olx.FrameState.prototype.pixelRatio; + + +/** @type {number} */ +olx.FrameState.prototype.time; + + +/** @type {olx.View2DState} */ +olx.FrameState.prototype.view2DState; + + +/** + * @typedef {{center: ol.Coordinate, + * projection: ol.proj.Projection, + * resolution: number, + * rotation: number}} + * @todo api + */ +olx.View2DState; + + +/** @type {ol.Coordinate} */ +olx.View2DState.prototype.center; + + +/** @type {number} */ +olx.View2DState.prototype.resolution; + + +/** @type {number} */ +olx.View2DState.prototype.rotation; diff --git a/externs/readme.md b/externs/readme.md index 9315b6b6c0..68253b3448 100644 --- a/externs/readme.md +++ b/externs/readme.md @@ -8,14 +8,14 @@ These two files are special externs that belong to ol3, and this document explai ### Prevent class properties from being renamed -For events, we make properties available to the application. Other than methods, which can be made available by just marking them with the `@api` annotation, properties are exported using `oli.js`: +For events, we make properties available to the application. Other than methods, which can be made available by just marking them with the `@api` annotation directly where they are defined, properties need to be added to `oli.js` in addition: + ```js /** @interface */ oli.MapBrowserEvent; /** * @type {ol.Coordinate} - * @todo api */ oli.MapBrowserEvent.prototype.coordinate; ``` @@ -32,6 +32,7 @@ ol.MapBrowserEvent = function(type, map, browserEvent, opt_frameState) { /** * @type {ol.Coordinate} + * @todo api */ this.coordinate = map.getEventCoordinate(this.originalEvent); diff --git a/src/ol/animation.js b/src/ol/animation.js index 29ec08499a..41fab3e6b0 100644 --- a/src/ol/animation.js +++ b/src/ol/animation.js @@ -22,7 +22,7 @@ ol.animation.bounce = function(options) { return ( /** * @param {ol.Map} map Map. - * @param {?oli.FrameState} frameState Frame state. + * @param {?olx.FrameState} frameState Frame state. */ function(map, frameState) { if (frameState.time < start) { @@ -59,7 +59,7 @@ ol.animation.pan = function(options) { return ( /** * @param {ol.Map} map Map. - * @param {?oli.FrameState} frameState Frame state. + * @param {?olx.FrameState} frameState Frame state. */ function(map, frameState) { if (frameState.time < start) { @@ -99,7 +99,7 @@ ol.animation.rotate = function(options) { return ( /** * @param {ol.Map} map Map. - * @param {?oli.FrameState} frameState Frame state. + * @param {?olx.FrameState} frameState Frame state. */ function(map, frameState) { if (frameState.time < start) { @@ -141,7 +141,7 @@ ol.animation.zoom = function(options) { return ( /** * @param {ol.Map} map Map. - * @param {?oli.FrameState} frameState Frame state. + * @param {?olx.FrameState} frameState Frame state. */ function(map, frameState) { if (frameState.time < start) { diff --git a/src/ol/collection.js b/src/ol/collection.js index d3101fb36d..1c64540447 100644 --- a/src/ol/collection.js +++ b/src/ol/collection.js @@ -47,6 +47,7 @@ ol.CollectionEvent = function(type, opt_element, opt_target) { /** * The element that is added to or removed from the collection. * @type {*} + * @todo api */ this.element = opt_element; diff --git a/src/ol/control/attributioncontrol.js b/src/ol/control/attributioncontrol.js index 46c257384e..d6aefde585 100644 --- a/src/ol/control/attributioncontrol.js +++ b/src/ol/control/attributioncontrol.js @@ -66,7 +66,7 @@ goog.inherits(ol.control.Attribution, ol.control.Control); /** - * @param {?oli.FrameState} frameState Frame state. + * @param {?olx.FrameState} frameState Frame state. * @return {Array.>} Attributions. */ ol.control.Attribution.prototype.getSourceAttributions = @@ -118,7 +118,7 @@ ol.control.Attribution.prototype.handleMapPostrender = function(mapEvent) { /** * @private - * @param {?oli.FrameState} frameState Frame state. + * @param {?olx.FrameState} frameState Frame state. */ ol.control.Attribution.prototype.updateElement_ = function(frameState) { diff --git a/src/ol/control/logocontrol.js b/src/ol/control/logocontrol.js index def0bb0453..314b3f9d35 100644 --- a/src/ol/control/logocontrol.js +++ b/src/ol/control/logocontrol.js @@ -65,7 +65,7 @@ ol.control.Logo.prototype.handleMapPostrender = function(mapEvent) { /** - * @param {?oli.FrameState} frameState Frame state. + * @param {?olx.FrameState} frameState Frame state. * @private */ ol.control.Logo.prototype.updateElement_ = function(frameState) { diff --git a/src/ol/control/scalelinecontrol.js b/src/ol/control/scalelinecontrol.js index 4ee84eb08a..79cae1f5a2 100644 --- a/src/ol/control/scalelinecontrol.js +++ b/src/ol/control/scalelinecontrol.js @@ -76,7 +76,7 @@ ol.control.ScaleLine = function(opt_options) { /** * @private - * @type {?oli.View2DState} + * @type {?olx.View2DState} */ this.view2DState_ = null; diff --git a/src/ol/framestate.js b/src/ol/framestate.js index 8eccdbb9c4..5692caaa38 100644 --- a/src/ol/framestate.js +++ b/src/ol/framestate.js @@ -6,17 +6,17 @@ goog.provide('ol.PreRenderFunction'); /** - * @typedef {function(ol.Map, ?oli.FrameState): boolean} + * @typedef {function(ol.Map, ?olx.FrameState): boolean} */ ol.PostRenderFunction; /** * Function to perform manipulations before rendering. This function is called - * with the {@link ol.Map} as first and an optional {@link oli.FrameState} as + * with the {@link ol.Map} as first and an optional {@link olx.FrameState} as * second argument. Return `true` to keep this function for the next frame, * `false` to remove it. - * @typedef {function(ol.Map, ?oli.FrameState): boolean} + * @typedef {function(ol.Map, ?olx.FrameState): boolean} * @todo api */ ol.PreRenderFunction; diff --git a/src/ol/interaction/draganddropinteraction.js b/src/ol/interaction/draganddropinteraction.js index a2e4547024..c3c1adc4c3 100644 --- a/src/ol/interaction/draganddropinteraction.js +++ b/src/ol/interaction/draganddropinteraction.js @@ -205,16 +205,19 @@ ol.interaction.DragAndDropEvent = /** * @type {Array.|undefined} + * @todo api */ this.features = opt_features; /** * @type {File} + * @todo api */ this.file = file; /** * @type {ol.proj.Projection|undefined} + * @todo api */ this.projection = opt_projection; diff --git a/src/ol/interaction/dragboxinteraction.js b/src/ol/interaction/dragboxinteraction.js index 67540e9647..c016f974b5 100644 --- a/src/ol/interaction/dragboxinteraction.js +++ b/src/ol/interaction/dragboxinteraction.js @@ -59,6 +59,7 @@ ol.DragBoxEvent = function(type, coordinate) { * The coordinate of the drag event. * @const * @type {ol.Coordinate} + * @todo api */ this.coordinate = coordinate; diff --git a/src/ol/interaction/drawinteraction.js b/src/ol/interaction/drawinteraction.js index 722b99cae6..f06df46bfd 100644 --- a/src/ol/interaction/drawinteraction.js +++ b/src/ol/interaction/drawinteraction.js @@ -56,6 +56,7 @@ ol.DrawEvent = function(type, feature) { /** * The feature being drawn. * @type {ol.Feature} + * @todo api */ this.feature = feature; diff --git a/src/ol/iview2d.js b/src/ol/iview2d.js index 354ddb22b2..50ad5aa1cf 100644 --- a/src/ol/iview2d.js +++ b/src/ol/iview2d.js @@ -41,7 +41,7 @@ ol.IView2D.prototype.getRotation = function() { /** - * @return {oli.View2DState} View2D state. + * @return {olx.View2DState} View2D state. */ ol.IView2D.prototype.getView2DState = function() { }; diff --git a/src/ol/map.js b/src/ol/map.js index e6356b3c2e..1c075ad2f9 100644 --- a/src/ol/map.js +++ b/src/ol/map.js @@ -209,7 +209,7 @@ ol.Map = function(options) { /** * @private - * @type {?oli.FrameState} + * @type {?olx.FrameState} */ this.frameState_ = null; @@ -1178,7 +1178,7 @@ ol.Map.prototype.renderFrame_ = function(time) { var size = this.getSize(); var view = this.getView(); var view2D = goog.isDef(view) ? this.getView().getView2D() : undefined; - /** @type {?oli.FrameState} */ + /** @type {?olx.FrameState} */ var frameState = null; if (goog.isDef(size) && hasArea(size) && goog.isDef(view2D) && view2D.isDef()) { @@ -1189,7 +1189,7 @@ ol.Map.prototype.renderFrame_ = function(time) { layerStates[goog.getUid(layerStatesArray[i].layer)] = layerStatesArray[i]; } view2DState = view2D.getView2DState(); - frameState = /** @type {oli.FrameState} */ ({ + frameState = /** @type {olx.FrameState} */ ({ animate: false, attributions: {}, coordinateToPixelMatrix: this.coordinateToPixelMatrix_, diff --git a/src/ol/mapbrowserevent.js b/src/ol/mapbrowserevent.js index d381f9783c..5704354ca3 100644 --- a/src/ol/mapbrowserevent.js +++ b/src/ol/mapbrowserevent.js @@ -26,7 +26,7 @@ goog.require('ol.pointer.PointerEventHandler'); * @param {string} type Event type. * @param {ol.Map} map Map. * @param {goog.events.BrowserEvent} browserEvent Browser event. - * @param {?oli.FrameState=} opt_frameState Frame state. + * @param {?olx.FrameState=} opt_frameState Frame state. */ ol.MapBrowserEvent = function(type, map, browserEvent, opt_frameState) { @@ -41,16 +41,19 @@ ol.MapBrowserEvent = function(type, map, browserEvent, opt_frameState) { /** * @const * @type {Event} + * @todo api */ this.originalEvent = browserEvent.getBrowserEvent(); /** * @type {ol.Coordinate} + * @todo api */ this.coordinate = map.getEventCoordinate(this.originalEvent); /** * @type {ol.Pixel} + * @todo api */ this.pixel = map.getEventPixel(this.originalEvent); @@ -89,7 +92,7 @@ ol.MapBrowserEvent.prototype.stopPropagation = function() { * @param {string} type Event type. * @param {ol.Map} map Map. * @param {ol.pointer.PointerEvent} pointerEvent Pointer event. - * @param {?oli.FrameState=} opt_frameState Frame state. + * @param {?olx.FrameState=} opt_frameState Frame state. */ ol.MapBrowserPointerEvent = function(type, map, pointerEvent, opt_frameState) { diff --git a/src/ol/mapevent.js b/src/ol/mapevent.js index f6279cce22..4ac3bf4fd2 100644 --- a/src/ol/mapevent.js +++ b/src/ol/mapevent.js @@ -29,7 +29,7 @@ ol.MapEventType = { * @extends {goog.events.Event} * @param {string} type Event type. * @param {ol.Map} map Map. - * @param {?oli.FrameState=} opt_frameState Frame state. + * @param {?olx.FrameState=} opt_frameState Frame state. */ ol.MapEvent = function(type, map, opt_frameState) { @@ -41,7 +41,7 @@ ol.MapEvent = function(type, map, opt_frameState) { this.map = map; /** - * @type {?oli.FrameState} + * @type {?olx.FrameState} */ this.frameState = goog.isDef(opt_frameState) ? opt_frameState : null; diff --git a/src/ol/render/renderevent.js b/src/ol/render/renderevent.js index 7fdc3e513a..dcb2597ef5 100644 --- a/src/ol/render/renderevent.js +++ b/src/ol/render/renderevent.js @@ -35,7 +35,7 @@ ol.render.EventType = { * @param {ol.render.EventType} type Type. * @param {Object=} opt_target Target. * @param {ol.render.IVectorContext=} opt_vectorContext Vector context. - * @param {oli.FrameState=} opt_frameState Frame state. + * @param {olx.FrameState=} opt_frameState Frame state. * @param {?CanvasRenderingContext2D=} opt_context Context. * @param {?ol.webgl.Context=} opt_glContext WebGL Context. */ @@ -46,19 +46,23 @@ ol.render.Event = function( goog.base(this, type, opt_target); /** + * For canvas, this is an instance of {@link ol.render.canvas.Immediate}. * @type {ol.render.IVectorContext|undefined} + * @todo api */ this.vectorContext = opt_vectorContext; /** - * @type {oli.FrameState|undefined} + * @type {olx.FrameState|undefined} + * @todo api */ this.frameState = opt_frameState; /** - * Canvas context. Only available when a Canvas renderer is used, - * null otherwise. + * Canvas context. Only available when a Canvas renderer is used, null + * otherwise. * @type {CanvasRenderingContext2D|null|undefined} + * @todo api */ this.context = opt_context; @@ -66,6 +70,7 @@ ol.render.Event = function( * WebGL context. Only available when a WebGL renderer is used, null * otherwise. * @type {ol.webgl.Context|null|undefined} + * @todo api */ this.glContext = opt_glContext; diff --git a/src/ol/renderer/canvas/canvaslayerrenderer.js b/src/ol/renderer/canvas/canvaslayerrenderer.js index 0479b796b1..54375fc932 100644 --- a/src/ol/renderer/canvas/canvaslayerrenderer.js +++ b/src/ol/renderer/canvas/canvaslayerrenderer.js @@ -33,7 +33,7 @@ goog.inherits(ol.renderer.canvas.Layer, ol.renderer.Layer); /** - * @param {oli.FrameState} frameState Frame state. + * @param {olx.FrameState} frameState Frame state. * @param {ol.layer.LayerState} layerState Layer state. * @param {CanvasRenderingContext2D} context Context. */ @@ -77,7 +77,7 @@ ol.renderer.canvas.Layer.prototype.composeFrame = /** * @param {ol.render.EventType} type Event type. * @param {CanvasRenderingContext2D} context Context. - * @param {oli.FrameState} frameState Frame state. + * @param {olx.FrameState} frameState Frame state. * @param {goog.vec.Mat4.Number=} opt_transform Transform. * @private */ @@ -100,7 +100,7 @@ ol.renderer.canvas.Layer.prototype.dispatchComposeEvent_ = /** * @param {CanvasRenderingContext2D} context Context. - * @param {oli.FrameState} frameState Frame state. + * @param {olx.FrameState} frameState Frame state. * @param {goog.vec.Mat4.Number=} opt_transform Transform. * @protected */ @@ -113,7 +113,7 @@ ol.renderer.canvas.Layer.prototype.dispatchPostComposeEvent = /** * @param {CanvasRenderingContext2D} context Context. - * @param {oli.FrameState} frameState Frame state. + * @param {olx.FrameState} frameState Frame state. * @param {goog.vec.Mat4.Number=} opt_transform Transform. * @protected */ @@ -126,7 +126,7 @@ ol.renderer.canvas.Layer.prototype.dispatchPreComposeEvent = /** * @param {CanvasRenderingContext2D} context Context. - * @param {oli.FrameState} frameState Frame state. + * @param {olx.FrameState} frameState Frame state. * @param {goog.vec.Mat4.Number=} opt_transform Transform. * @protected */ @@ -150,7 +150,7 @@ ol.renderer.canvas.Layer.prototype.getImageTransform = goog.abstractMethod; /** - * @param {oli.FrameState} frameState Frame state. + * @param {olx.FrameState} frameState Frame state. * @protected * @return {!goog.vec.Mat4.Number} Transform. */ diff --git a/src/ol/renderer/canvas/canvasmaprenderer.js b/src/ol/renderer/canvas/canvasmaprenderer.js index 29686da90d..775fb51e07 100644 --- a/src/ol/renderer/canvas/canvasmaprenderer.js +++ b/src/ol/renderer/canvas/canvasmaprenderer.js @@ -87,7 +87,7 @@ ol.renderer.canvas.Map.prototype.createLayerRenderer = function(layer) { /** * @param {ol.render.EventType} type Event type. - * @param {oli.FrameState} frameState Frame state. + * @param {olx.FrameState} frameState Frame state. * @private */ ol.renderer.canvas.Map.prototype.dispatchComposeEvent_ = diff --git a/src/ol/renderer/layerrenderer.js b/src/ol/renderer/layerrenderer.js index 424985fc1d..904f7395c2 100644 --- a/src/ol/renderer/layerrenderer.js +++ b/src/ol/renderer/layerrenderer.js @@ -45,7 +45,7 @@ goog.inherits(ol.renderer.Layer, goog.Disposable); /** * @param {ol.Coordinate} coordinate Coordinate. - * @param {oli.FrameState} frameState Frame state. + * @param {olx.FrameState} frameState Frame state. * @param {function(this: S, ol.Feature, ol.layer.Layer): T} callback Feature * callback. * @param {S} thisArg Value to use as `this` when executing `callback`. @@ -96,7 +96,7 @@ ol.renderer.Layer.prototype.handleImageChange = function(event) { /** - * @param {oli.FrameState} frameState Frame state. + * @param {olx.FrameState} frameState Frame state. * @param {ol.layer.LayerState} layerState Layer state. */ ol.renderer.Layer.prototype.prepareFrame = goog.abstractMethod; @@ -114,7 +114,7 @@ ol.renderer.Layer.prototype.renderIfReadyAndVisible = function() { /** - * @param {oli.FrameState} frameState Frame state. + * @param {olx.FrameState} frameState Frame state. * @param {ol.source.Tile} tileSource Tile source. * @protected */ @@ -126,7 +126,7 @@ ol.renderer.Layer.prototype.scheduleExpireCache = /** * @param {ol.source.Tile} tileSource Tile source. * @param {ol.Map} map Map. - * @param {oli.FrameState} frameState Frame state. + * @param {olx.FrameState} frameState Frame state. */ function(tileSource, map, frameState) { var tileSourceKey = goog.getUid(tileSource).toString(); @@ -155,7 +155,7 @@ ol.renderer.Layer.prototype.updateAttributions = /** - * @param {oli.FrameState} frameState Frame state. + * @param {olx.FrameState} frameState Frame state. * @param {ol.source.Source} source Source. * @protected */ @@ -241,7 +241,7 @@ ol.renderer.Layer.prototype.snapCenterToPixel = * - registers idle tiles in frameState.wantedTiles so that they are not * discarded by the tile queue * - enqueues missing tiles - * @param {oli.FrameState} frameState Frame state. + * @param {olx.FrameState} frameState Frame state. * @param {ol.source.Tile} tileSource Tile source. * @param {ol.tilegrid.TileGrid} tileGrid Tile grid. * @param {number} pixelRatio Pixel ratio. diff --git a/src/ol/renderer/maprenderer.js b/src/ol/renderer/maprenderer.js index f041562fe9..c18f162f20 100644 --- a/src/ol/renderer/maprenderer.js +++ b/src/ol/renderer/maprenderer.js @@ -41,7 +41,7 @@ goog.inherits(ol.renderer.Map, goog.Disposable); /** - * @param {oli.FrameState} frameState FrameState. + * @param {olx.FrameState} frameState FrameState. * @protected */ ol.renderer.Map.prototype.calculateMatrices2D = function(frameState) { @@ -82,7 +82,7 @@ ol.renderer.Map.prototype.disposeInternal = function() { /** * @param {ol.Coordinate} coordinate Coordinate. - * @param {oli.FrameState} frameState FrameState. + * @param {olx.FrameState} frameState FrameState. * @param {function(this: S, ol.Feature, ol.layer.Layer): T} callback Feature * callback. * @param {S} thisArg Value to use as `this` when executing `callback`. @@ -176,14 +176,14 @@ ol.renderer.Map.prototype.removeLayerRendererByKey_ = function(layerKey) { /** * Render. - * @param {?oli.FrameState} frameState Frame state. + * @param {?olx.FrameState} frameState Frame state. */ ol.renderer.Map.prototype.renderFrame = goog.nullFunction; /** * @param {ol.Map} map Map. - * @param {oli.FrameState} frameState Frame state. + * @param {olx.FrameState} frameState Frame state. * @private */ ol.renderer.Map.prototype.removeUnusedLayerRenderers_ = @@ -198,14 +198,14 @@ ol.renderer.Map.prototype.removeUnusedLayerRenderers_ = /** - * @param {oli.FrameState} frameState Frame state. + * @param {olx.FrameState} frameState Frame state. * @protected */ ol.renderer.Map.prototype.scheduleExpireIconCache = function(frameState) { frameState.postRenderFunctions.push( /** * @param {ol.Map} map Map. - * @param {oli.FrameState} frameState Frame state. + * @param {olx.FrameState} frameState Frame state. */ function(map, frameState) { ol.style.IconImageCache.getInstance().expire(); @@ -214,7 +214,7 @@ ol.renderer.Map.prototype.scheduleExpireIconCache = function(frameState) { /** - * @param {!oli.FrameState} frameState Frame state. + * @param {!olx.FrameState} frameState Frame state. * @protected */ ol.renderer.Map.prototype.scheduleRemoveUnusedLayerRenderers = diff --git a/src/ol/renderer/webgl/webgllayerrenderer.js b/src/ol/renderer/webgl/webgllayerrenderer.js index 2f34e15643..707a661abd 100644 --- a/src/ol/renderer/webgl/webgllayerrenderer.js +++ b/src/ol/renderer/webgl/webgllayerrenderer.js @@ -88,7 +88,7 @@ goog.inherits(ol.renderer.webgl.Layer, ol.renderer.Layer); /** - * @param {oli.FrameState} frameState Frame state. + * @param {olx.FrameState} frameState Frame state. * @param {number} framebufferDimension Framebuffer dimension. * @protected */ @@ -142,7 +142,7 @@ ol.renderer.webgl.Layer.prototype.bindFramebuffer = /** - * @param {oli.FrameState} frameState Frame state. + * @param {olx.FrameState} frameState Frame state. * @param {ol.layer.LayerState} layerState Layer state. * @param {ol.webgl.Context} context Context. */ @@ -230,7 +230,7 @@ ol.renderer.webgl.Layer.prototype.composeFrame = /** * @param {ol.render.EventType} type Event type. * @param {ol.webgl.Context} context WebGL context. - * @param {oli.FrameState} frameState Frame state. + * @param {olx.FrameState} frameState Frame state. * @private */ ol.renderer.webgl.Layer.prototype.dispatchComposeEvent_ = diff --git a/src/ol/renderer/webgl/webglmaprenderer.js b/src/ol/renderer/webgl/webglmaprenderer.js index fd2b0c7c58..1e7a736d0c 100644 --- a/src/ol/renderer/webgl/webglmaprenderer.js +++ b/src/ol/renderer/webgl/webglmaprenderer.js @@ -257,7 +257,7 @@ ol.renderer.webgl.Map.prototype.createLayerRenderer = function(layer) { /** * @param {ol.render.EventType} type Event type. - * @param {oli.FrameState} frameState Frame state. + * @param {olx.FrameState} frameState Frame state. * @private */ ol.renderer.webgl.Map.prototype.dispatchComposeEvent_ = @@ -297,7 +297,7 @@ ol.renderer.webgl.Map.prototype.disposeInternal = function() { /** * @param {ol.Map} map Map. - * @param {oli.FrameState} frameState Frame state. + * @param {olx.FrameState} frameState Frame state. * @private */ ol.renderer.webgl.Map.prototype.expireCache_ = function(map, frameState) { diff --git a/src/ol/source/tilesource.js b/src/ol/source/tilesource.js index fdcbcef744..d030568e6c 100644 --- a/src/ol/source/tilesource.js +++ b/src/ol/source/tilesource.js @@ -27,7 +27,6 @@ ol.source.TileOptions; * @constructor * @extends {ol.source.Source} * @param {ol.source.TileOptions} options Tile source options. - * @todo api */ ol.source.Tile = function(options) { diff --git a/src/ol/source/vectorsource.js b/src/ol/source/vectorsource.js index e16c38130b..92b726bb8f 100644 --- a/src/ol/source/vectorsource.js +++ b/src/ol/source/vectorsource.js @@ -404,6 +404,7 @@ ol.source.VectorEvent = function(type, opt_feature) { /** * The feature being added or removed. * @type {ol.Feature|undefined} + * @todo api */ this.feature = opt_feature; diff --git a/src/ol/view2d.js b/src/ol/view2d.js index a7ceb527c5..68061b2676 100644 --- a/src/ol/view2d.js +++ b/src/ol/view2d.js @@ -379,7 +379,7 @@ ol.View2D.prototype.getView2DState = function() { var projection = this.getProjection(); var resolution = /** @type {number} */ (this.getResolution()); var rotation = this.getRotation(); - return /** @type {oli.View2DState} */ ({ + return /** @type {olx.View2DState} */ ({ center: center.slice(), projection: goog.isDef(projection) ? projection : null, resolution: resolution, diff --git a/src/oli.jsdoc b/src/oli.jsdoc deleted file mode 100644 index bc7e58e4f1..0000000000 --- a/src/oli.jsdoc +++ /dev/null @@ -1,3 +0,0 @@ -/** - * @namespace oli - */