Add documentation for API typedef functions

2014-02-13 13:23:04 +01:00
parent 20402a6e71
commit 87d651af04
6 changed files with 36 additions and 1 deletions
@@ -8,7 +8,11 @@ goog.require('ol.MapBrowserEvent.EventType');


 /**
+ * A function that takes an {@link ol.MapBrowserEvent} and returns a
+ * `{boolean}`. If the condition is met, true should be returned.
+ *
 * @typedef {function(ol.MapBrowserEvent): boolean}
+ * @todo stability experimental
 */
 ol.events.ConditionType;