Add @classdesc to classes

This commit is contained in:
Peter Robins
2014-06-08 09:48:29 -04:00
parent e08a98b624
commit 41d9f0360a
111 changed files with 369 additions and 40 deletions
+5 -3
View File
@@ -13,10 +13,12 @@ goog.require('ol.css');
/**
* Create a new attribution control to show all the attributions associated
* with the layer sources in the map. A default map has this control included.
* By default it will show in the bottom right portion of the map, but it can
* @classdesc
* Control to show all the attributions associated with the layer sources
* in the map. This control is one of the default controls included in maps.
* By default it will show in the bottom right portion of the map, but this can
* be changed by using a css selector for `.ol-attribution`.
*
* @constructor
* @extends {ol.control.Control}
* @param {olx.control.AttributionOptions=} opt_options Attribution options.
+6 -2
View File
@@ -9,8 +9,12 @@ goog.require('ol.Object');
/**
* Something to be painted over the map to provide a means for interaction
* (buttons) or to show annotations (status bars).
* @classdesc
* Abstract parent class for controls.
* A control is a visible widget with a DOM element in a fixed position on the
* screen. They can involve user input (buttons), or be informational only;
* the position is determined using CSS. By default these are part of the map
* container, but can use any outside DOM element.
*
* @constructor
* @extends {ol.Object}
+5 -2
View File
@@ -8,12 +8,15 @@ goog.require('ol.control.Zoom');
/**
* Set of default controls. Unless configured otherwise, this returns a
* collection containing an instance of each of the following controls:
* @classdesc
* Set of controls included in maps by default. Unless configured otherwise,
* this returns a collection containing an instance of each of the following
* controls:
* * {@link ol.control.Zoom}
* * {@link ol.control.Rotate}
* * {@link ol.control.Attribution}
* * {@link ol.control.Logo}
*
* @param {olx.control.DefaultsOptions=} opt_options Defaults options.
* @return {ol.Collection} Controls.
* @todo api
+1
View File
@@ -15,6 +15,7 @@ goog.require('ol.pointer.PointerEventHandler');
/**
* @classdesc
* Provides a button that when clicked fills up the full screen with the map.
* When in full screen mode, a close button is shown to exit full screen mode.
* The [Fullscreen API](http://www.w3.org/TR/fullscreen/) is used to
+2
View File
@@ -10,10 +10,12 @@ goog.require('ol.css');
/**
* @classdesc
* Shows a logo for all the layer sources in the map that have a logo
* associated with them, such as Bing. This control is part of a default map.
* By default it will show in the bottom-left portion of the map, but it can
* be styled by using a css selector for `.ol-logo`.
*
* @constructor
* @extends {ol.control.Control}
* @param {olx.control.LogoOptions=} opt_options Logo options.
+5 -4
View File
@@ -28,10 +28,11 @@ ol.control.MousePositionProperty = {
/**
* Create a new control to show the position of the mouse in the map's
* projection (or any other supplied projection). By default the control is
* shown in the top right corner of the map but this can be changed by using
* a css selector `.ol-mouse-position`.
* @classdesc
* A control to show the 2D coordinates of the mouse cursor. By default, these
* are in the view projection, but can be in any supported projection.
* By default the control is shown in the top right corner of the map, but this
* can be changed by using the css selector `.ol-mouse-position`.
*
* @constructor
* @extends {ol.control.Control}
+3 -1
View File
@@ -17,8 +17,10 @@ goog.require('ol.pointer.PointerEventHandler');
/**
* Create a new control with a button, to reset rotation to 0.
* @classdesc
* A button control to reset rotation to 0.
* To style this control use css selector `.ol-rotate`.
*
* @constructor
* @extends {ol.control.Control}
* @param {olx.control.RotateOptions=} opt_options Rotate options.
+4 -3
View File
@@ -42,9 +42,10 @@ ol.control.ScaleLineUnits = {
/**
* Create a control to help users estimate distances on a map.
* By default it will show in the bottom left portion of the map, but it can
* be changed by using a css selector for `.ol-scale-line`.
* @classdesc
* A control displaying rough x-axis distances.
* By default it will show in the bottom left portion of the map, but this can
* be changed by using the css selector `.ol-scale-line`.
*
* @constructor
* @extends {ol.control.Control}
+4 -2
View File
@@ -17,9 +17,11 @@ goog.require('ol.pointer.PointerEventHandler');
/**
* Create a new control with 2 buttons, one for zoom in and one for zoom out.
* This control is part of the default controls of a map. To style this control
* @classdesc
* A control with 2 buttons, one for zoom in and one for zoom out.
* This control is one of the default controls of a map. To style this control
* use css selectors `.ol-zoom-in` and `.ol-zoom-out`.
*
* @constructor
* @extends {ol.control.Control}
* @param {olx.control.ZoomOptions=} opt_options Zoom options.
+1
View File
@@ -23,6 +23,7 @@ goog.require('ol.easing');
/**
* @classdesc
* A slider type of control for zooming.
*
* Example:
+4 -3
View File
@@ -14,9 +14,10 @@ goog.require('ol.pointer.PointerEventHandler');
/**
* Create a control that adds a button, which, when pressed, changes
* the map view to a specific extent. To style this control use the
* css selector `.ol-zoom-extent`.
* @classdesc
* A button control which, when pressed, changes the map view to a specific
* extent. To style this control use the css selector `.ol-zoom-extent`.
*
* @constructor
* @extends {ol.control.Control}
* @param {olx.control.ZoomToExtentOptions=} opt_options Options.