ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #2564 from elemoine/apistable4

Browse Source 
Add @api stable annotations for the ol.control namespace
This commit is contained in:
Éric Lemoine
2014-08-21 11:02:56 +02:00
parent a54a485faf 24651ba21e
commit 55db958290
11 changed files with 30 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
externs/olx.js
View File

@@ -10,7 +10,7 @@ var olx;
/**
* @typedef {{html: string,
* tileRanges: (Object.<string, Array.<ol.TileRange>>|undefined)}}
* @api
* @api stable
*/
olx.AttributionOptions;
@@ -772,7 +772,7 @@ olx.control.AttributionOptions.prototype.collapseLabel;
/**
* @typedef {{element: (Element|undefined),
* target: (Element|string|undefined)}}
* @api
* @api stable
*/
olx.control.ControlOptions;
@@ -890,7 +890,7 @@ olx.control.FullScreenOptions.prototype.target;
* projection: ol.proj.ProjectionLike,
* target: (Element|undefined),
* undefinedHTML: (string|undefined)}}
* @api
* @api stable
*/
olx.control.MousePositionOptions;
@@ -935,7 +935,7 @@ olx.control.MousePositionOptions.prototype.undefinedHTML;
* minWidth: (number|undefined),
* target: (Element|undefined),
* units: (ol.control.ScaleLineUnits|string|undefined)}}
* @api
* @api stable
*/
olx.control.ScaleLineOptions;
@@ -975,7 +975,7 @@ olx.control.ScaleLineOptions.prototype.units;
* tipLabel: (string|undefined),
* target: (Element|undefined),
* autoHide: (boolean|undefined)}}
* @api
* @api stable
*/
olx.control.RotateOptions;
@@ -1031,7 +1031,7 @@ olx.control.RotateOptions.prototype.target;
* zoomOutTipLabel: (string|undefined),
* delta: (number|undefined),
* target: (Element|undefined)}}
* @api
* @api stable
*/
olx.control.ZoomOptions;
@@ -1096,7 +1096,7 @@ olx.control.ZoomOptions.prototype.target;
* @typedef {{className: (string|undefined),
* maxResolution: (number|undefined),
* minResolution: (number|undefined)}}
* @api
* @api stable
*/
olx.control.ZoomSliderOptions;
@@ -1127,7 +1127,7 @@ olx.control.ZoomSliderOptions.prototype.minResolution;
* target: (Element|undefined),
* tipLabel: (string|undefined),
* extent: (ol.Extent|undefined)}}
* @api
* @api stable
*/
olx.control.ZoomToExtentOptions;

10
src/ol/control/attributioncontrol.js
View File

@@ -26,7 +26,7 @@ goog.require('ol.pointer.PointerEventHandler');
* @constructor
* @extends {ol.control.Control}
* @param {olx.control.AttributionOptions=} opt_options Attribution options.
* @api
* @api stable
*/
ol.control.Attribution = function(opt_options) {
@@ -362,7 +362,7 @@ ol.control.Attribution.prototype.handleToggle_ = function() {
/**
* @return {boolean} True if the widget is collapsible.
* @api
* @api stable
*/
ol.control.Attribution.prototype.getCollapsible = function() {
return this.collapsible_;
@@ -371,7 +371,7 @@ ol.control.Attribution.prototype.getCollapsible = function() {
/**
* @param {boolean} collapsible True if the widget is collapsible.
* @api
* @api stable
*/
ol.control.Attribution.prototype.setCollapsible = function(collapsible) {
if (this.collapsible_ === collapsible) {
@@ -387,7 +387,7 @@ ol.control.Attribution.prototype.setCollapsible = function(collapsible) {
/**
* @param {boolean} collapsed True if the widget is collapsed.
* @api
* @api stable
*/
ol.control.Attribution.prototype.setCollapsed = function(collapsed) {
if (!this.collapsible_ || this.collapsed_ === collapsed) {
@@ -399,7 +399,7 @@ ol.control.Attribution.prototype.setCollapsed = function(collapsed) {
/**
* @return {boolean} True if the widget is collapsed.
* @api
* @api stable
*/
ol.control.Attribution.prototype.getCollapsed = function() {
return this.collapsed_;

2
src/ol/control/control.js
View File

@@ -82,7 +82,7 @@ ol.control.Control.prototype.disposeInternal = function() {
/**
* Get the map associated with this control.
* @return {ol.Map} Map.
* @api
* @api stable
*/
ol.control.Control.prototype.getMap = function() {
return this.map_;

2
src/ol/control/controldefaults.js
View File

@@ -16,7 +16,7 @@ goog.require('ol.control.Zoom');
*
* @param {olx.control.DefaultsOptions=} opt_options Defaults options.
* @return {ol.Collection.<ol.control.Control>} Controls.
* @api
* @api stable
*/
ol.control.defaults = function(opt_options) {

2
src/ol/control/fullscreencontrol.js
View File

@@ -25,7 +25,7 @@ goog.require('ol.pointer.PointerEventHandler');
* @constructor
* @extends {ol.control.Control}
* @param {olx.control.FullScreenOptions=} opt_options Options.
* @api
* @api stable
*/
ol.control.FullScreen = function(opt_options) {

12
src/ol/control/mousepositioncontrol.js
View File

@@ -37,7 +37,7 @@ ol.control.MousePositionProperty = {
* @extends {ol.control.Control}
* @param {olx.control.MousePositionOptions=} opt_options Mouse position
* options.
* @api
* @api stable
*/
ol.control.MousePosition = function(opt_options) {
@@ -130,7 +130,7 @@ ol.control.MousePosition.prototype.handleProjectionChanged_ = function() {
* @return {ol.CoordinateFormatType|undefined} The format to render the current
* position in.
* @observable
* @api
* @api stable
*/
ol.control.MousePosition.prototype.getCoordinateFormat = function() {
return /** @type {ol.CoordinateFormatType|undefined} */ (
@@ -146,7 +146,7 @@ goog.exportProperty(
* @return {ol.proj.Projection|undefined} The projection to report mouse
* position in.
* @observable
* @api
* @api stable
*/
ol.control.MousePosition.prototype.getProjection = function() {
return /** @type {ol.proj.Projection|undefined} */ (
@@ -183,7 +183,7 @@ ol.control.MousePosition.prototype.handleMouseOut = function(browserEvent) {
/**
* @inheritDoc
* @api
* @api stable
*/
ol.control.MousePosition.prototype.setMap = function(map) {
goog.base(this, 'setMap', map);
@@ -203,7 +203,7 @@ ol.control.MousePosition.prototype.setMap = function(map) {
* @param {ol.CoordinateFormatType} format The format to render the current
* position in.
* @observable
* @api
* @api stable
*/
ol.control.MousePosition.prototype.setCoordinateFormat = function(format) {
this.set(ol.control.MousePositionProperty.COORDINATE_FORMAT, format);
@@ -218,7 +218,7 @@ goog.exportProperty(
* @param {ol.proj.Projection} projection The projection to report mouse
* position in.
* @observable
* @api
* @api stable
*/
ol.control.MousePosition.prototype.setProjection = function(projection) {
this.set(ol.control.MousePositionProperty.PROJECTION, projection);

2
src/ol/control/rotatecontrol.js
View File

@@ -22,7 +22,7 @@ goog.require('ol.pointer.PointerEventHandler');
* @constructor
* @extends {ol.control.Control}
* @param {olx.control.RotateOptions=} opt_options Rotate options.
* @api
* @api stable
*/
ol.control.Rotate = function(opt_options) {

8
src/ol/control/scalelinecontrol.js
View File

@@ -29,7 +29,7 @@ ol.control.ScaleLineProperty = {
* Units for the scale line. Supported values are `'degrees'`, `'imperial'`,
* `'nautical'`, `'metric'`, `'us'`.
* @enum {string}
* @api
* @api stable
*/
ol.control.ScaleLineUnits = {
DEGREES: 'degrees',
@@ -53,7 +53,7 @@ ol.control.ScaleLineUnits = {
* @constructor
* @extends {ol.control.Control}
* @param {olx.control.ScaleLineOptions=} opt_options Scale line options.
* @api
* @api stable
*/
ol.control.ScaleLine = function(opt_options) {
@@ -141,7 +141,7 @@ ol.control.ScaleLine.LEADING_DIGITS = [1, 2, 5];
* @return {ol.control.ScaleLineUnits|undefined} The units to use in the scale
* line.
* @observable
* @api
* @api stable
*/
ol.control.ScaleLine.prototype.getUnits = function() {
return /** @type {ol.control.ScaleLineUnits|undefined} */ (
@@ -178,7 +178,7 @@ ol.control.ScaleLine.prototype.handleUnitsChanged_ = function() {
/**
* @param {ol.control.ScaleLineUnits} units The units to use in the scale line.
* @observable
* @api
* @api stable
*/
ol.control.ScaleLine.prototype.setUnits = function(units) {
this.set(ol.control.ScaleLineProperty.UNITS, units);

2
src/ol/control/zoomcontrol.js
View File

@@ -21,7 +21,7 @@ goog.require('ol.pointer.PointerEventHandler');
* @constructor
* @extends {ol.control.Control}
* @param {olx.control.ZoomOptions=} opt_options Zoom options.
* @api
* @api stable
*/
ol.control.Zoom = function(opt_options) {

2
src/ol/control/zoomslidercontrol.js
View File

@@ -32,7 +32,7 @@ goog.require('ol.easing');
* @constructor
* @extends {ol.control.Control}
* @param {olx.control.ZoomSliderOptions=} opt_options Zoom slider options.
* @api
* @api stable
*/
ol.control.ZoomSlider = function(opt_options) {

2
src/ol/control/zoomtoextentcontrol.js
View File

@@ -19,7 +19,7 @@ goog.require('ol.pointer.PointerEventHandler');
* @constructor
* @extends {ol.control.Control}
* @param {olx.control.ZoomToExtentOptions=} opt_options Options.
* @api
* @api stable
*/
ol.control.ZoomToExtent = function(opt_options) {
var options = goog.isDef(opt_options) ? opt_options : {};