Merge pull request #2043 from ahocevar/nicer-api-docs

Nicer API docs
This commit is contained in:
Andreas Hocevar
2014-05-07 09:20:22 -05:00
81 changed files with 2267 additions and 934 deletions

View File

@@ -19,8 +19,7 @@ goog.require('ol.proj');
/**
* @constructor
* @extends {ol.interaction.Interaction}
* @fires {@link ol.interaction.DragAndDropEvent}
* ol.interaction.DragAndDropEvent
* @fires ol.interaction.DragAndDropEvent
* @param {olx.interaction.DragAndDropOptions=} opt_options Options.
* @todo api
*/

View File

@@ -76,7 +76,7 @@ goog.inherits(ol.DragBoxEvent, goog.events.Event);
*
* @constructor
* @extends {ol.interaction.Pointer}
* @fires {@link ol.DragBoxEvent} ol.DragBoxEvent
* @fires ol.DragBoxEvent
* @param {olx.interaction.DragBoxOptions=} opt_options Options.
* @todo api
*/

View File

@@ -68,7 +68,7 @@ goog.inherits(ol.DrawEvent, goog.events.Event);
* Interaction that allows drawing geometries
* @constructor
* @extends {ol.interaction.Pointer}
* @fires {@link ol.DrawEvent} ol.DrawEvent
* @fires ol.DrawEvent
* @param {olx.interaction.DrawOptions} options Options.
* @todo api
*/

View File

@@ -19,9 +19,9 @@ goog.require('ol.interaction.PinchZoom');
* setting the appropriate option to false in the constructor options,
* but the order of the interactions is fixed. If you want to specify a
* different order for interactions, you will need to create your own
* {@link ol.interaction} instances and insert them into an
* {@link ol.Collection} in the order you want before creating your ol.Map
* instance.
* {@link ol.interaction.Interaction} instances and insert them into a
* {@link ol.Collection} in the order you want before creating your
* {@link ol.Map} instance.
* @param {olx.interaction.DefaultsOptions=} opt_options Defaults options.
* @return {ol.Collection} A collection of interactions to be used with
* the ol.Map constructor's interactions option.