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

Remaining valid-jsdoc corrections

Browse Source
This commit is contained in:
Tim Schaub
2016-01-09 11:37:28 -07:00
parent e6f6dcc230
commit 59a66c7aaa
26 changed files with 128 additions and 130 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
src/ol/pointer/eventsource.js
View File

@@ -5,8 +5,9 @@ goog.require('goog.events.BrowserEvent');
/**
* @param {ol.pointer.PointerEventHandler} dispatcher
* @param {!Object.<string, function(goog.events.BrowserEvent)>} mapping
* @param {ol.pointer.PointerEventHandler} dispatcher Event handler.
* @param {!Object.<string, function(goog.events.BrowserEvent)>} mapping Event
* mapping.
* @constructor
*/
ol.pointer.EventSource = function(dispatcher, mapping) {
@@ -46,7 +47,7 @@ ol.pointer.EventSource.prototype.getMapping = function() {
/**
* Returns the handler that should handle a given event type.
* @param {string} eventType
* @param {string} eventType The event type.
* @return {function(goog.events.BrowserEvent)} Handler
*/
ol.pointer.EventSource.prototype.getHandlerForEvent = function(eventType) {

22
src/ol/pointer/mousesource.js
View File

@@ -35,7 +35,7 @@ goog.require('ol.pointer.EventSource');
/**
* @param {ol.pointer.PointerEventHandler} dispatcher
* @param {ol.pointer.PointerEventHandler} dispatcher Event handler.
* @constructor
* @extends {ol.pointer.EventSource}
*/
@@ -108,7 +108,7 @@ ol.pointer.MouseSource.DEDUP_DIST = 25;
* or detect that the positions are invalid.
*
* @private
* @param {goog.events.BrowserEvent} inEvent
* @param {goog.events.BrowserEvent} inEvent The in event.
* @return {boolean} True, if the event was generated by a touch.
*/
ol.pointer.MouseSource.prototype.isEventSimulatedFromTouch_ =
@@ -131,9 +131,9 @@ ol.pointer.MouseSource.prototype.isEventSimulatedFromTouch_ =
* Creates a copy of the original event that will be used
* for the fake pointer event.
*
* @param {goog.events.BrowserEvent} inEvent
* @param {ol.pointer.PointerEventHandler} dispatcher
* @return {Object}
* @param {goog.events.BrowserEvent} inEvent The in event.
* @param {ol.pointer.PointerEventHandler} dispatcher Event handler.
* @return {Object} The copied event.
*/
ol.pointer.MouseSource.prepareEvent = function(inEvent, dispatcher) {
var e = dispatcher.cloneEvent(inEvent, inEvent.getBrowserEvent());
@@ -156,7 +156,7 @@ ol.pointer.MouseSource.prepareEvent = function(inEvent, dispatcher) {
/**
* Handler for `mousedown`.
*
* @param {goog.events.BrowserEvent} inEvent
* @param {goog.events.BrowserEvent} inEvent The in event.
*/
ol.pointer.MouseSource.prototype.mousedown = function(inEvent) {
if (!this.isEventSimulatedFromTouch_(inEvent)) {
@@ -175,7 +175,7 @@ ol.pointer.MouseSource.prototype.mousedown = function(inEvent) {
/**
* Handler for `mousemove`.
*
* @param {goog.events.BrowserEvent} inEvent
* @param {goog.events.BrowserEvent} inEvent The in event.
*/
ol.pointer.MouseSource.prototype.mousemove = function(inEvent) {
if (!this.isEventSimulatedFromTouch_(inEvent)) {
@@ -188,7 +188,7 @@ ol.pointer.MouseSource.prototype.mousemove = function(inEvent) {
/**
* Handler for `mouseup`.
*
* @param {goog.events.BrowserEvent} inEvent
* @param {goog.events.BrowserEvent} inEvent The in event.
*/
ol.pointer.MouseSource.prototype.mouseup = function(inEvent) {
if (!this.isEventSimulatedFromTouch_(inEvent)) {
@@ -206,7 +206,7 @@ ol.pointer.MouseSource.prototype.mouseup = function(inEvent) {
/**
* Handler for `mouseover`.
*
* @param {goog.events.BrowserEvent} inEvent
* @param {goog.events.BrowserEvent} inEvent The in event.
*/
ol.pointer.MouseSource.prototype.mouseover = function(inEvent) {
if (!this.isEventSimulatedFromTouch_(inEvent)) {
@@ -219,7 +219,7 @@ ol.pointer.MouseSource.prototype.mouseover = function(inEvent) {
/**
* Handler for `mouseout`.
*
* @param {goog.events.BrowserEvent} inEvent
* @param {goog.events.BrowserEvent} inEvent The in event.
*/
ol.pointer.MouseSource.prototype.mouseout = function(inEvent) {
if (!this.isEventSimulatedFromTouch_(inEvent)) {
@@ -232,7 +232,7 @@ ol.pointer.MouseSource.prototype.mouseout = function(inEvent) {
/**
* Dispatches a `pointercancel` event.
*
* @param {goog.events.BrowserEvent} inEvent
* @param {goog.events.BrowserEvent} inEvent The in event.
*/
ol.pointer.MouseSource.prototype.cancel = function(inEvent) {
var e = ol.pointer.MouseSource.prepareEvent(inEvent, this.dispatcher);

24
src/ol/pointer/mssource.js
View File

@@ -35,7 +35,7 @@ goog.require('ol.pointer.EventSource');
/**
* @param {ol.pointer.PointerEventHandler} dispatcher
* @param {ol.pointer.PointerEventHandler} dispatcher Event handler.
* @constructor
* @extends {ol.pointer.EventSource}
*/
@@ -78,8 +78,8 @@ goog.inherits(ol.pointer.MsSource, ol.pointer.EventSource);
* for the fake pointer event.
*
* @private
* @param {goog.events.BrowserEvent} inEvent
* @return {Object}
* @param {goog.events.BrowserEvent} inEvent The in event.
* @return {Object} The copied event.
*/
ol.pointer.MsSource.prototype.prepareEvent_ = function(inEvent) {
var e = inEvent;
@@ -94,7 +94,7 @@ ol.pointer.MsSource.prototype.prepareEvent_ = function(inEvent) {
/**
* Remove this pointer from the list of active pointers.
* @param {number} pointerId
* @param {number} pointerId Pointer identifier.
*/
ol.pointer.MsSource.prototype.cleanup = function(pointerId) {
delete this.pointerMap[pointerId.toString()];
@@ -104,7 +104,7 @@ ol.pointer.MsSource.prototype.cleanup = function(pointerId) {
/**
* Handler for `msPointerDown`.
*
* @param {goog.events.BrowserEvent} inEvent
* @param {goog.events.BrowserEvent} inEvent The in event.
*/
ol.pointer.MsSource.prototype.msPointerDown = function(inEvent) {
this.pointerMap[inEvent.getBrowserEvent().pointerId.toString()] = inEvent;
@@ -116,7 +116,7 @@ ol.pointer.MsSource.prototype.msPointerDown = function(inEvent) {
/**
* Handler for `msPointerMove`.
*
* @param {goog.events.BrowserEvent} inEvent
* @param {goog.events.BrowserEvent} inEvent The in event.
*/
ol.pointer.MsSource.prototype.msPointerMove = function(inEvent) {
var e = this.prepareEvent_(inEvent);
@@ -127,7 +127,7 @@ ol.pointer.MsSource.prototype.msPointerMove = function(inEvent) {
/**
* Handler for `msPointerUp`.
*
* @param {goog.events.BrowserEvent} inEvent
* @param {goog.events.BrowserEvent} inEvent The in event.
*/
ol.pointer.MsSource.prototype.msPointerUp = function(inEvent) {
var e = this.prepareEvent_(inEvent);
@@ -139,7 +139,7 @@ ol.pointer.MsSource.prototype.msPointerUp = function(inEvent) {
/**
* Handler for `msPointerOut`.
*
* @param {goog.events.BrowserEvent} inEvent
* @param {goog.events.BrowserEvent} inEvent The in event.
*/
ol.pointer.MsSource.prototype.msPointerOut = function(inEvent) {
var e = this.prepareEvent_(inEvent);
@@ -150,7 +150,7 @@ ol.pointer.MsSource.prototype.msPointerOut = function(inEvent) {
/**
* Handler for `msPointerOver`.
*
* @param {goog.events.BrowserEvent} inEvent
* @param {goog.events.BrowserEvent} inEvent The in event.
*/
ol.pointer.MsSource.prototype.msPointerOver = function(inEvent) {
var e = this.prepareEvent_(inEvent);
@@ -161,7 +161,7 @@ ol.pointer.MsSource.prototype.msPointerOver = function(inEvent) {
/**
* Handler for `msPointerCancel`.
*
* @param {goog.events.BrowserEvent} inEvent
* @param {goog.events.BrowserEvent} inEvent The in event.
*/
ol.pointer.MsSource.prototype.msPointerCancel = function(inEvent) {
var e = this.prepareEvent_(inEvent);
@@ -173,7 +173,7 @@ ol.pointer.MsSource.prototype.msPointerCancel = function(inEvent) {
/**
* Handler for `msLostPointerCapture`.
*
* @param {goog.events.BrowserEvent} inEvent
* @param {goog.events.BrowserEvent} inEvent The in event.
*/
ol.pointer.MsSource.prototype.msLostPointerCapture = function(inEvent) {
var e = this.dispatcher.makeEvent('lostpointercapture',
@@ -185,7 +185,7 @@ ol.pointer.MsSource.prototype.msLostPointerCapture = function(inEvent) {
/**
* Handler for `msGotPointerCapture`.
*
* @param {goog.events.BrowserEvent} inEvent
* @param {goog.events.BrowserEvent} inEvent The in event.
*/
ol.pointer.MsSource.prototype.msGotPointerCapture = function(inEvent) {
var e = this.dispatcher.makeEvent('gotpointercapture',

18
src/ol/pointer/nativesource.js
View File

@@ -35,7 +35,7 @@ goog.require('ol.pointer.EventSource');
/**
* @param {ol.pointer.PointerEventHandler} dispatcher
* @param {ol.pointer.PointerEventHandler} dispatcher Event handler.
* @constructor
* @extends {ol.pointer.EventSource}
*/
@@ -58,7 +58,7 @@ goog.inherits(ol.pointer.NativeSource, ol.pointer.EventSource);
/**
* Handler for `pointerdown`.
*
* @param {goog.events.BrowserEvent} inEvent
* @param {goog.events.BrowserEvent} inEvent The in event.
*/
ol.pointer.NativeSource.prototype.pointerDown = function(inEvent) {
this.dispatcher.fireNativeEvent(inEvent);
@@ -68,7 +68,7 @@ ol.pointer.NativeSource.prototype.pointerDown = function(inEvent) {
/**
* Handler for `pointermove`.
*
* @param {goog.events.BrowserEvent} inEvent
* @param {goog.events.BrowserEvent} inEvent The in event.
*/
ol.pointer.NativeSource.prototype.pointerMove = function(inEvent) {
this.dispatcher.fireNativeEvent(inEvent);
@@ -78,7 +78,7 @@ ol.pointer.NativeSource.prototype.pointerMove = function(inEvent) {
/**
* Handler for `pointerup`.
*
* @param {goog.events.BrowserEvent} inEvent
* @param {goog.events.BrowserEvent} inEvent The in event.
*/
ol.pointer.NativeSource.prototype.pointerUp = function(inEvent) {
this.dispatcher.fireNativeEvent(inEvent);
@@ -88,7 +88,7 @@ ol.pointer.NativeSource.prototype.pointerUp = function(inEvent) {
/**
* Handler for `pointerout`.
*
* @param {goog.events.BrowserEvent} inEvent
* @param {goog.events.BrowserEvent} inEvent The in event.
*/
ol.pointer.NativeSource.prototype.pointerOut = function(inEvent) {
this.dispatcher.fireNativeEvent(inEvent);
@@ -98,7 +98,7 @@ ol.pointer.NativeSource.prototype.pointerOut = function(inEvent) {
/**
* Handler for `pointerover`.
*
* @param {goog.events.BrowserEvent} inEvent
* @param {goog.events.BrowserEvent} inEvent The in event.
*/
ol.pointer.NativeSource.prototype.pointerOver = function(inEvent) {
this.dispatcher.fireNativeEvent(inEvent);
@@ -108,7 +108,7 @@ ol.pointer.NativeSource.prototype.pointerOver = function(inEvent) {
/**
* Handler for `pointercancel`.
*
* @param {goog.events.BrowserEvent} inEvent
* @param {goog.events.BrowserEvent} inEvent The in event.
*/
ol.pointer.NativeSource.prototype.pointerCancel = function(inEvent) {
this.dispatcher.fireNativeEvent(inEvent);
@@ -118,7 +118,7 @@ ol.pointer.NativeSource.prototype.pointerCancel = function(inEvent) {
/**
* Handler for `lostpointercapture`.
*
* @param {goog.events.BrowserEvent} inEvent
* @param {goog.events.BrowserEvent} inEvent The in event.
*/
ol.pointer.NativeSource.prototype.lostPointerCapture = function(inEvent) {
this.dispatcher.fireNativeEvent(inEvent);
@@ -128,7 +128,7 @@ ol.pointer.NativeSource.prototype.lostPointerCapture = function(inEvent) {
/**
* Handler for `gotpointercapture`.
*
* @param {goog.events.BrowserEvent} inEvent
* @param {goog.events.BrowserEvent} inEvent The in event.
*/
ol.pointer.NativeSource.prototype.gotPointerCapture = function(inEvent) {
this.dispatcher.fireNativeEvent(inEvent);

12
src/ol/pointer/pointerevent.js
View File

@@ -45,7 +45,7 @@ goog.require('goog.events.Event');
* @constructor
* @extends {goog.events.Event}
* @param {string} type The type of the event to create.
* @param {goog.events.BrowserEvent} browserEvent
* @param {goog.events.BrowserEvent} browserEvent The event.
* @param {Object.<string, ?>=} opt_eventDict An optional dictionary of
* initial event properties.
*/
@@ -198,8 +198,8 @@ goog.inherits(ol.pointer.PointerEvent, goog.events.Event);
/**
* @private
* @param {Object.<string, ?>} eventDict
* @return {number}
* @param {Object.<string, ?>} eventDict The event dictionary.
* @return {number} Button indicator.
*/
ol.pointer.PointerEvent.prototype.getButtons_ = function(eventDict) {
// According to the w3c spec,
@@ -240,9 +240,9 @@ ol.pointer.PointerEvent.prototype.getButtons_ = function(eventDict) {
/**
* @private
* @param {Object.<string, ?>} eventDict
* @param {number} buttons
* @return {number}
* @param {Object.<string, ?>} eventDict The event dictionary.
* @param {number} buttons Button indicator.
* @return {number} The pressure.
*/
ol.pointer.PointerEvent.prototype.getPressure_ = function(eventDict, buttons) {
// Spec requires that pointers without pressure specified use 0.5 for down

58
src/ol/pointer/pointereventhandler.js
View File

@@ -110,7 +110,7 @@ ol.pointer.PointerEventHandler.prototype.registerSources = function() {
* Add a new event source that will generate pointer events.
*
* @param {string} name A name for the event source
* @param {ol.pointer.EventSource} source
* @param {ol.pointer.EventSource} source The source event.
*/
ol.pointer.PointerEventHandler.prototype.registerSource =
function(name, source) {
@@ -227,8 +227,8 @@ ol.pointer.PointerEventHandler.prototype.cloneEvent =
/**
* Triggers a 'pointerdown' event.
* @param {Object} pointerEventData
* @param {goog.events.BrowserEvent} browserEvent
* @param {Object} pointerEventData Pointer event data.
* @param {goog.events.BrowserEvent} browserEvent The event.
*/
ol.pointer.PointerEventHandler.prototype.down =
function(pointerEventData, browserEvent) {
@@ -239,8 +239,8 @@ ol.pointer.PointerEventHandler.prototype.down =
/**
* Triggers a 'pointermove' event.
* @param {Object} pointerEventData
* @param {goog.events.BrowserEvent} browserEvent
* @param {Object} pointerEventData Pointer event data.
* @param {goog.events.BrowserEvent} browserEvent The event.
*/
ol.pointer.PointerEventHandler.prototype.move =
function(pointerEventData, browserEvent) {
@@ -251,8 +251,8 @@ ol.pointer.PointerEventHandler.prototype.move =
/**
* Triggers a 'pointerup' event.
* @param {Object} pointerEventData
* @param {goog.events.BrowserEvent} browserEvent
* @param {Object} pointerEventData Pointer event data.
* @param {goog.events.BrowserEvent} browserEvent The event.
*/
ol.pointer.PointerEventHandler.prototype.up =
function(pointerEventData, browserEvent) {
@@ -263,8 +263,8 @@ ol.pointer.PointerEventHandler.prototype.up =
/**
* Triggers a 'pointerenter' event.
* @param {Object} pointerEventData
* @param {goog.events.BrowserEvent} browserEvent
* @param {Object} pointerEventData Pointer event data.
* @param {goog.events.BrowserEvent} browserEvent The event.
*/
ol.pointer.PointerEventHandler.prototype.enter =
function(pointerEventData, browserEvent) {
@@ -276,8 +276,8 @@ ol.pointer.PointerEventHandler.prototype.enter =
/**
* Triggers a 'pointerleave' event.
* @param {Object} pointerEventData
* @param {goog.events.BrowserEvent} browserEvent
* @param {Object} pointerEventData Pointer event data.
* @param {goog.events.BrowserEvent} browserEvent The event.
*/
ol.pointer.PointerEventHandler.prototype.leave =
function(pointerEventData, browserEvent) {
@@ -289,8 +289,8 @@ ol.pointer.PointerEventHandler.prototype.leave =
/**
* Triggers a 'pointerover' event.
* @param {Object} pointerEventData
* @param {goog.events.BrowserEvent} browserEvent
* @param {Object} pointerEventData Pointer event data.
* @param {goog.events.BrowserEvent} browserEvent The event.
*/
ol.pointer.PointerEventHandler.prototype.over =
function(pointerEventData, browserEvent) {
@@ -302,8 +302,8 @@ ol.pointer.PointerEventHandler.prototype.over =
/**
* Triggers a 'pointerout' event.
* @param {Object} pointerEventData
* @param {goog.events.BrowserEvent} browserEvent
* @param {Object} pointerEventData Pointer event data.
* @param {goog.events.BrowserEvent} browserEvent The event.
*/
ol.pointer.PointerEventHandler.prototype.out =
function(pointerEventData, browserEvent) {
@@ -315,8 +315,8 @@ ol.pointer.PointerEventHandler.prototype.out =
/**
* Triggers a 'pointercancel' event.
* @param {Object} pointerEventData
* @param {goog.events.BrowserEvent} browserEvent
* @param {Object} pointerEventData Pointer event data.
* @param {goog.events.BrowserEvent} browserEvent The event.
*/
ol.pointer.PointerEventHandler.prototype.cancel =
function(pointerEventData, browserEvent) {
@@ -327,8 +327,8 @@ ol.pointer.PointerEventHandler.prototype.cancel =
/**
* Triggers a combination of 'pointerout' and 'pointerleave' events.
* @param {Object} pointerEventData
* @param {goog.events.BrowserEvent} browserEvent
* @param {Object} pointerEventData Pointer event data.
* @param {goog.events.BrowserEvent} browserEvent The event.
*/
ol.pointer.PointerEventHandler.prototype.leaveOut =
function(pointerEventData, browserEvent) {
@@ -343,8 +343,8 @@ ol.pointer.PointerEventHandler.prototype.leaveOut =
/**
* Triggers a combination of 'pointerover' and 'pointerevents' events.
* @param {Object} pointerEventData
* @param {goog.events.BrowserEvent} browserEvent
* @param {Object} pointerEventData Pointer event data.
* @param {goog.events.BrowserEvent} browserEvent The event.
*/
ol.pointer.PointerEventHandler.prototype.enterOver =
function(pointerEventData, browserEvent) {
@@ -359,8 +359,8 @@ ol.pointer.PointerEventHandler.prototype.enterOver =
/**
* @private
* @param {Element} container
* @param {Element} contained
* @param {Element} container The container element.
* @param {Element} contained The contained element.
* @return {boolean} Returns true if the container element
* contains the other element.
*/
@@ -379,8 +379,8 @@ ol.pointer.PointerEventHandler.prototype.contains_ =
* `pointerEventData`.
*
* @param {string} inType A string representing the type of event to create.
* @param {Object} pointerEventData
* @param {goog.events.BrowserEvent} browserEvent
* @param {Object} pointerEventData Pointer event data.
* @param {goog.events.BrowserEvent} browserEvent The event.
* @return {ol.pointer.PointerEvent} A PointerEvent of type `inType`.
*/
ol.pointer.PointerEventHandler.prototype.makeEvent =
@@ -392,8 +392,8 @@ ol.pointer.PointerEventHandler.prototype.makeEvent =
/**
* Make and dispatch an event in one call.
* @param {string} inType A string representing the type of event.
* @param {Object} pointerEventData
* @param {goog.events.BrowserEvent} browserEvent
* @param {Object} pointerEventData Pointer event data.
* @param {goog.events.BrowserEvent} browserEvent The event.
*/
ol.pointer.PointerEventHandler.prototype.fireEvent =
function(inType, pointerEventData, browserEvent) {
@@ -419,8 +419,8 @@ ol.pointer.PointerEventHandler.prototype.fireNativeEvent =
* Wrap a native mouse event into a pointer event.
* This proxy method is required for the legacy IE support.
* @param {string} eventType The pointer event type.
* @param {goog.events.BrowserEvent} browserEvent
* @return {ol.pointer.PointerEvent}
* @param {goog.events.BrowserEvent} browserEvent The event.
* @return {ol.pointer.PointerEvent} The wrapped event.
*/
ol.pointer.PointerEventHandler.prototype.wrapMouseEvent =
function(eventType, browserEvent) {

12
src/ol/pointer/touchsource.js
View File

@@ -179,7 +179,7 @@ ol.pointer.TouchSource.prototype.cancelResetClickCount_ = function() {
* @private
* @param {goog.events.BrowserEvent} browserEvent Browser event
* @param {Touch} inTouch Touch event
* @return {Object}
* @return {Object} A pointer object.
*/
ol.pointer.TouchSource.prototype.touchToPointer_ =
function(browserEvent, inTouch) {
@@ -215,7 +215,7 @@ ol.pointer.TouchSource.prototype.touchToPointer_ =
/**
* @private
* @param {goog.events.BrowserEvent} inEvent Touch event
* @param {function(goog.events.BrowserEvent, Object)} inFunction
* @param {function(goog.events.BrowserEvent, Object)} inFunction In function.
*/
ol.pointer.TouchSource.prototype.processTouches_ =
function(inEvent, inFunction) {
@@ -337,8 +337,8 @@ ol.pointer.TouchSource.prototype.touchmove = function(inEvent) {
/**
* @private
* @param {goog.events.BrowserEvent} browserEvent
* @param {Object} inPointer
* @param {goog.events.BrowserEvent} browserEvent The event.
* @param {Object} inPointer The in pointer.
*/
ol.pointer.TouchSource.prototype.moveOverOut_ =
function(browserEvent, inPointer) {
@@ -409,8 +409,8 @@ ol.pointer.TouchSource.prototype.touchcancel = function(inEvent) {
/**
* @private
* @param {goog.events.BrowserEvent} browserEvent
* @param {Object} inPointer
* @param {goog.events.BrowserEvent} browserEvent The event.
* @param {Object} inPointer The in pointer.
*/
ol.pointer.TouchSource.prototype.cancelOut_ =
function(browserEvent, inPointer) {