Annotations for exports

This commit is contained in:
Tim Schaub
2014-04-08 13:40:35 -06:00
parent 457cfe851a
commit fb497f5288
243 changed files with 456 additions and 451 deletions
-8
View File
@@ -1,8 +0,0 @@
@exportSymbol ol.events.condition.altKeyOnly
@exportSymbol ol.events.condition.altShiftKeysOnly
@exportSymbol ol.events.condition.always
@exportSymbol ol.events.condition.never
@exportSymbol ol.events.condition.noModifierKeys
@exportSymbol ol.events.condition.platformModifierKeyOnly
@exportSymbol ol.events.condition.shiftKeyOnly
@exportSymbol ol.events.condition.targetNotEditable
+8
View File
@@ -22,6 +22,7 @@ ol.events.ConditionType;
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} True if only the alt key is pressed.
* @todo stability experimental
* @todo api
*/
ol.events.condition.altKeyOnly = function(mapBrowserEvent) {
var browserEvent = mapBrowserEvent.browserEvent;
@@ -36,6 +37,7 @@ ol.events.condition.altKeyOnly = function(mapBrowserEvent) {
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} True if only the alt and shift keys are pressed.
* @todo stability experimental
* @todo api
*/
ol.events.condition.altShiftKeysOnly = function(mapBrowserEvent) {
var browserEvent = mapBrowserEvent.browserEvent;
@@ -51,6 +53,7 @@ ol.events.condition.altShiftKeysOnly = function(mapBrowserEvent) {
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} True.
* @todo stability experimental
* @todo api
*/
ol.events.condition.always = goog.functions.TRUE;
@@ -60,6 +63,7 @@ ol.events.condition.always = goog.functions.TRUE;
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} False.
* @todo stability experimental
* @todo api
*/
ol.events.condition.never = goog.functions.FALSE;
@@ -78,6 +82,7 @@ ol.events.condition.singleClick = function(mapBrowserEvent) {
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} True only if there no modifier keys are pressed.
* @todo stability experimental
* @todo api
*/
ol.events.condition.noModifierKeys = function(mapBrowserEvent) {
var browserEvent = mapBrowserEvent.browserEvent;
@@ -92,6 +97,7 @@ ol.events.condition.noModifierKeys = function(mapBrowserEvent) {
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} True if only the platform modifier key is pressed.
* @todo stability experimental
* @todo api
*/
ol.events.condition.platformModifierKeyOnly = function(mapBrowserEvent) {
var browserEvent = mapBrowserEvent.browserEvent;
@@ -106,6 +112,7 @@ ol.events.condition.platformModifierKeyOnly = function(mapBrowserEvent) {
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} True if only the shift key is pressed.
* @todo stability experimental
* @todo api
*/
ol.events.condition.shiftKeyOnly = function(mapBrowserEvent) {
var browserEvent = mapBrowserEvent.browserEvent;
@@ -120,6 +127,7 @@ ol.events.condition.shiftKeyOnly = function(mapBrowserEvent) {
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} True only if the target element is not editable.
* @todo stability experimental
* @todo api
*/
ol.events.condition.targetNotEditable = function(mapBrowserEvent) {
var target = mapBrowserEvent.browserEvent.target;