All @api annotations imply stability

2017-02-06 09:22:05 -07:00
parent ca23c7337f
commit f5aea97d3b
109 changed files with 705 additions and 747 deletions
@@ -21,7 +21,7 @@ goog.require('ol.obj');
 * @constructor
 * @extends {ol.control.Control}
 * @param {olx.control.AttributionOptions=} opt_options Attribution options.
- * @api stable
+ * @api
 */
 ol.control.Attribution = function(opt_options) {

@@ -359,7 +359,7 @@ ol.control.Attribution.prototype.handleToggle_ = function() {
 /**
 * Return `true` if the attribution is collapsible, `false` otherwise.
 * @return {boolean} True if the widget is collapsible.
- * @api stable
+ * @api
 */
 ol.control.Attribution.prototype.getCollapsible = function() {
  return this.collapsible_;
@@ -369,7 +369,7 @@ ol.control.Attribution.prototype.getCollapsible = function() {
 /**
 * Set whether the attribution should be collapsible.
 * @param {boolean} collapsible True if the widget is collapsible.
- * @api stable
+ * @api
 */
 ol.control.Attribution.prototype.setCollapsible = function(collapsible) {
  if (this.collapsible_ === collapsible) {
@@ -388,7 +388,7 @@ ol.control.Attribution.prototype.setCollapsible = function(collapsible) {
 * not do anything if the attribution isn't collapsible or if the current
 * collapsed state is already the one requested.
 * @param {boolean} collapsed True if the widget is collapsed.
- * @api stable
+ * @api
 */
 ol.control.Attribution.prototype.setCollapsed = function(collapsed) {
  if (!this.collapsible_ || this.collapsed_ === collapsed) {
@@ -402,7 +402,7 @@ ol.control.Attribution.prototype.setCollapsed = function(collapsed) {
 * Return `true` when the attribution is currently collapsed or `false`
 * otherwise.
 * @return {boolean} True if the widget is collapsed.
- * @api stable
+ * @api
 */
 ol.control.Attribution.prototype.getCollapsed = function() {
  return this.collapsed_;
@@ -34,7 +34,7 @@ goog.require('ol.events');
 * @extends {ol.Object}
 * @implements {oli.control.Control}
 * @param {olx.control.ControlOptions} options Control options.
- * @api stable
+ * @api
 */
 ol.control.Control = function(options) {

@@ -89,7 +89,7 @@ ol.control.Control.prototype.disposeInternal = function() {
 /**
 * Get the map associated with this control.
 * @return {ol.Map} Map.
- * @api stable
+ * @api
 */
 ol.control.Control.prototype.getMap = function() {
  return this.map_;
@@ -102,7 +102,7 @@ ol.control.Control.prototype.getMap = function() {
 * the map here.
 * @param {ol.Map} map Map.
 * @override
- * @api stable
+ * @api
 */
 ol.control.Control.prototype.setMap = function(map) {
  if (this.map_) {
@@ -23,7 +23,7 @@ goog.require('ol.events.EventType');
 * @constructor
 * @extends {ol.control.Control}
 * @param {olx.control.FullScreenOptions=} opt_options Options.
- * @api stable
+ * @api
 */
 ol.control.FullScreen = function(opt_options) {

@@ -155,7 +155,7 @@ ol.control.FullScreen.prototype.handleFullScreenChange_ = function() {

 /**
 * @inheritDoc
- * @api stable
+ * @api
 */
 ol.control.FullScreen.prototype.setMap = function(map) {
  ol.control.Control.prototype.setMap.call(this, map);
@@ -21,7 +21,7 @@ goog.require('ol.proj');
 * @extends {ol.control.Control}
 * @param {olx.control.MousePositionOptions=} opt_options Mouse position
 *     options.
- * @api stable
+ * @api
 */
 ol.control.MousePosition = function(opt_options) {

@@ -118,7 +118,7 @@ ol.control.MousePosition.prototype.handleProjectionChanged_ = function() {
 * @return {ol.CoordinateFormatType|undefined} The format to render the current
 *     position in.
 * @observable
- * @api stable
+ * @api
 */
 ol.control.MousePosition.prototype.getCoordinateFormat = function() {
  return /** @type {ol.CoordinateFormatType|undefined} */ (
@@ -131,7 +131,7 @@ ol.control.MousePosition.prototype.getCoordinateFormat = function() {
 * @return {ol.proj.Projection|undefined} The projection to report mouse
 *     position in.
 * @observable
- * @api stable
+ * @api
 */
 ol.control.MousePosition.prototype.getProjection = function() {
  return /** @type {ol.proj.Projection|undefined} */ (
@@ -162,7 +162,7 @@ ol.control.MousePosition.prototype.handleMouseOut = function(event) {

 /**
 * @inheritDoc
- * @api stable
+ * @api
 */
 ol.control.MousePosition.prototype.setMap = function(map) {
  ol.control.Control.prototype.setMap.call(this, map);
@@ -183,7 +183,7 @@ ol.control.MousePosition.prototype.setMap = function(map) {
 * @param {ol.CoordinateFormatType} format The format to render the current
 *     position in.
 * @observable
- * @api stable
+ * @api
 */
 ol.control.MousePosition.prototype.setCoordinateFormat = function(format) {
  this.set(ol.control.MousePosition.Property_.COORDINATE_FORMAT, format);
@@ -195,7 +195,7 @@ ol.control.MousePosition.prototype.setCoordinateFormat = function(format) {
 * @param {ol.proj.Projection} projection The projection to report mouse
 *     position in.
 * @observable
- * @api stable
+ * @api
 */
 ol.control.MousePosition.prototype.setProjection = function(projection) {
  this.set(ol.control.MousePosition.Property_.PROJECTION, projection);
@@ -462,7 +462,7 @@ ol.control.OverviewMap.prototype.handleToggle_ = function() {
 /**
 * Return `true` if the overview map is collapsible, `false` otherwise.
 * @return {boolean} True if the widget is collapsible.
- * @api stable
+ * @api
 */
 ol.control.OverviewMap.prototype.getCollapsible = function() {
  return this.collapsible_;
@@ -472,7 +472,7 @@ ol.control.OverviewMap.prototype.getCollapsible = function() {
 /**
 * Set whether the overview map should be collapsible.
 * @param {boolean} collapsible True if the widget is collapsible.
- * @api stable
+ * @api
 */
 ol.control.OverviewMap.prototype.setCollapsible = function(collapsible) {
  if (this.collapsible_ === collapsible) {
@@ -491,7 +491,7 @@ ol.control.OverviewMap.prototype.setCollapsible = function(collapsible) {
 * not do anything if the overview map isn't collapsible or if the current
 * collapsed state is already the one requested.
 * @param {boolean} collapsed True if the widget is collapsed.
- * @api stable
+ * @api
 */
 ol.control.OverviewMap.prototype.setCollapsed = function(collapsed) {
  if (!this.collapsible_ || this.collapsed_ === collapsed) {
@@ -504,7 +504,7 @@ ol.control.OverviewMap.prototype.setCollapsed = function(collapsed) {
 /**
 * Determine if the overview map is collapsed.
 * @return {boolean} The overview map is collapsed.
- * @api stable
+ * @api
 */
 ol.control.OverviewMap.prototype.getCollapsed = function() {
  return this.collapsed_;
@@ -17,7 +17,7 @@ goog.require('ol.easing');
 * @constructor
 * @extends {ol.control.Control}
 * @param {olx.control.RotateOptions=} opt_options Rotate options.
- * @api stable
+ * @api
 */
 ol.control.Rotate = function(opt_options) {

@@ -24,7 +24,7 @@ goog.require('ol.proj.Units');
 * @constructor
 * @extends {ol.control.Control}
 * @param {olx.control.ScaleLineOptions=} opt_options Scale line options.
- * @api stable
+ * @api
 */
 ol.control.ScaleLine = function(opt_options) {

@@ -108,7 +108,7 @@ ol.control.ScaleLine.LEADING_DIGITS = [1, 2, 5];
 * @return {ol.control.ScaleLineUnits|undefined} The units to use in the scale
 *     line.
 * @observable
- * @api stable
+ * @api
 */
 ol.control.ScaleLine.prototype.getUnits = function() {
  return /** @type {ol.control.ScaleLineUnits|undefined} */ (
@@ -145,7 +145,7 @@ ol.control.ScaleLine.prototype.handleUnitsChanged_ = function() {
 * Set the units to use in the scale line.
 * @param {ol.control.ScaleLineUnits} units The units to use in the scale line.
 * @observable
- * @api stable
+ * @api
 */
 ol.control.ScaleLine.prototype.setUnits = function(units) {
  this.set(ol.control.ScaleLine.Property_.UNITS, units);
@@ -17,7 +17,7 @@ goog.require('ol.easing');
 * @constructor
 * @extends {ol.control.Control}
 * @param {olx.control.ZoomOptions=} opt_options Zoom options.
- * @api stable
+ * @api
 */
 ol.control.Zoom = function(opt_options) {

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

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