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

Add default stability level to docs of exported things.

Browse Source
This commit is contained in:
Paul Spencer
2013-10-24 17:07:02 -04:00
parent a13c5d30a2
commit bada596b45
108 changed files with 382 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -22,6 +22,7 @@ goog.require('ol.css');
* @constructor
* @extends {ol.control.Control}
* @param {ol.control.AttributionOptions=} opt_options Attribution options.
* @todo stability experimental
*/
ol.control.Attribution = function(opt_options) {

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

@@ -16,6 +16,7 @@ goog.require('ol.Object');
* @extends {ol.Object}
* @implements {oli.control.Control}
* @param {ol.control.ControlOptions} options Control options.
* @todo stability experimental
*/
ol.control.Control = function(options) {
@@ -61,6 +62,7 @@ ol.control.Control.prototype.disposeInternal = function() {
/**
* Get the map associated with this control.
* @return {ol.Map} Map.
* @todo stability experimental
*/
ol.control.Control.prototype.getMap = function() {
return this.map_;
@@ -81,6 +83,7 @@ ol.control.Control.prototype.handleMapPostrender = goog.nullFunction;
* Subclasses may set up event handlers to get notified about changes to
* the map here.
* @param {ol.Map} map Map.
* @todo stability experimental
*/
ol.control.Control.prototype.setMap = function(map) {
if (!goog.isNull(this.map_)) {

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

@@ -9,6 +9,7 @@ goog.require('ol.control.Zoom');
/**
* @param {ol.control.DefaultsOptions=} opt_options Defaults options.
* @return {ol.Collection} Controls.
* @todo stability experimental
*/
ol.control.defaults = function(opt_options) {

1
src/ol/control/dragboxcontrol.js
View File

@@ -27,6 +27,7 @@ ol.control.DragBoxOptions;
* @constructor
* @extends {ol.control.Control}
* @param {ol.control.DragBoxOptions} options Drag box options.
* @todo stability experimental
*/
ol.control.DragBox = function(options) {

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

@@ -23,6 +23,7 @@ goog.require('ol.css');
* @constructor
* @extends {ol.control.Control}
* @param {ol.control.FullScreenOptions=} opt_options Options.
* @todo stability experimental
*/
ol.control.FullScreen = function(opt_options) {

1
src/ol/control/logocontrol.js
View File

@@ -18,6 +18,7 @@ goog.require('ol.css');
* @constructor
* @extends {ol.control.Control}
* @param {ol.control.LogoOptions=} opt_options Logo options.
* @todo stability experimental
*/
ol.control.Logo = function(opt_options) {

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

@@ -37,6 +37,7 @@ ol.control.MousePositionProperty = {
* @constructor
* @extends {ol.control.Control}
* @param {ol.control.MousePositionOptions=} opt_options Mouse position options.
* @todo stability experimental
*/
ol.control.MousePosition = function(opt_options) {
@@ -127,6 +128,7 @@ ol.control.MousePosition.prototype.handleProjectionChanged_ = function() {
/**
* @return {ol.CoordinateFormatType|undefined} projection.
* @todo stability experimental
*/
ol.control.MousePosition.prototype.getCoordinateFormat = function() {
return /** @type {ol.CoordinateFormatType|undefined} */ (
@@ -140,6 +142,7 @@ goog.exportProperty(
/**
* @return {ol.proj.Projection|undefined} projection.
* @todo stability experimental
*/
ol.control.MousePosition.prototype.getProjection = function() {
return /** @type {ol.proj.Projection|undefined} */ (
@@ -193,6 +196,7 @@ ol.control.MousePosition.prototype.setMap = function(map) {
/**
* @param {ol.CoordinateFormatType} format Coordinate format.
* @todo stability experimental
*/
ol.control.MousePosition.prototype.setCoordinateFormat = function(format) {
this.set(ol.control.MousePositionProperty.COORDINATE_FORMAT, format);
@@ -205,6 +209,7 @@ goog.exportProperty(
/**
* @param {ol.proj.Projection} projection Projection.
* @todo stability experimental
*/
ol.control.MousePosition.prototype.setProjection = function(projection) {
this.set(ol.control.MousePositionProperty.PROJECTION, projection);

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

@@ -21,6 +21,7 @@ goog.require('ol.sphere.NORMAL');
/**
* @enum {string}
* @todo stability experimental
*/
ol.control.ScaleLineProperty = {
UNITS: 'units'
@@ -29,6 +30,7 @@ ol.control.ScaleLineProperty = {
/**
* @enum {string}
* @todo stability experimental
*/
ol.control.ScaleLineUnits = {
DEGREES: 'degrees',
@@ -48,6 +50,7 @@ ol.control.ScaleLineUnits = {
* @constructor
* @extends {ol.control.Control}
* @param {ol.control.ScaleLineOptions=} opt_options Scale line options.
* @todo stability experimental
*/
ol.control.ScaleLine = function(opt_options) {
@@ -126,12 +129,14 @@ goog.inherits(ol.control.ScaleLine, ol.control.Control);
/**
* @const
* @type {Array.<number>}
* @todo stability experimental
*/
ol.control.ScaleLine.LEADING_DIGITS = [1, 2, 5];
/**
* @return {ol.control.ScaleLineUnits|undefined} units.
* @todo stability experimental
*/
ol.control.ScaleLine.prototype.getUnits = function() {
return /** @type {ol.control.ScaleLineUnits|undefined} */ (
@@ -167,6 +172,7 @@ ol.control.ScaleLine.prototype.handleUnitsChanged_ = function() {
/**
* @param {ol.control.ScaleLineUnits} units Units.
* @todo stability experimental
*/
ol.control.ScaleLine.prototype.setUnits = function(units) {
this.set(ol.control.ScaleLineProperty.UNITS, units);

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

@@ -20,6 +20,7 @@ goog.require('ol.easing');
* @constructor
* @extends {ol.control.Control}
* @param {ol.control.ZoomOptions=} opt_options Zoom options.
* @todo stability experimental
*/
ol.control.Zoom = function(opt_options) {

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

@@ -38,6 +38,7 @@ ol.control.ZOOMSLIDER_ANIMATION_DURATION = 200;
* @constructor
* @extends {ol.control.Control}
* @param {ol.control.ZoomSliderOptions=} opt_options Zoom slider options.
* @todo stability experimental
*/
ol.control.ZoomSlider = function(opt_options) {

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

@@ -18,6 +18,7 @@ goog.require('ol.css');
* @constructor
* @extends {ol.control.Control}
* @param {ol.control.ZoomToExtentOptions=} opt_options Options.
* @todo stability experimental
*/
ol.control.ZoomToExtent = function(opt_options) {
var options = goog.isDef(opt_options) ? opt_options : {};