Valid JSDoc annotations

This commit is contained in:
Tim Schaub
2016-01-03 11:35:38 -07:00
parent 154b8babc4
commit f627f7679b
@@ -59,6 +59,7 @@ describe('ol.interaction.Modify', function() {
* @param {number} x Horizontal offset from map center. * @param {number} x Horizontal offset from map center.
* @param {number} y Vertical offset from map center. * @param {number} y Vertical offset from map center.
* @param {boolean=} opt_shiftKey Shift key is pressed. * @param {boolean=} opt_shiftKey Shift key is pressed.
* @param {number} button The mouse button.
*/ */
function simulateEvent(type, x, y, opt_shiftKey, button) { function simulateEvent(type, x, y, opt_shiftKey, button) {
var viewport = map.getViewport(); var viewport = map.getViewport();
@@ -82,7 +83,7 @@ describe('ol.interaction.Modify', function() {
* Tracks events triggered by the interaction as well as feature * Tracks events triggered by the interaction as well as feature
* modifications. Helper function to * modifications. Helper function to
* @param {ol.Feature} feature Modified feature. * @param {ol.Feature} feature Modified feature.
* @param {ol.interaction.Modify} interaction * @param {ol.interaction.Modify} interaction The interaction.
* @return {Array<ol.interaction.ModifyEvent|string>} events * @return {Array<ol.interaction.ModifyEvent|string>} events
*/ */
function trackEvents(feature, interaction) { function trackEvents(feature, interaction) {
@@ -103,8 +104,8 @@ describe('ol.interaction.Modify', function() {
* Validates the event array to verify proper event sequence. Checks * Validates the event array to verify proper event sequence. Checks
* that first and last event are correct ModifyEvents and that feature * that first and last event are correct ModifyEvents and that feature
* modifications event are in between. * modifications event are in between.
* @param {Array<ol.interaction.ModifyEvent|string>} event * @param {Array<ol.interaction.ModifyEvent|string>} events The events.
* @param {Array<ol.Feature>} features * @param {Array<ol.Feature>} features The features.
*/ */
function validateEvents(events, features) { function validateEvents(events, features) {