Use @api annotation instead of @todo api

2014-07-05 15:41:14 -04:00
parent 297503e7c9
commit 4cf5ab4620
155 changed files with 759 additions and 757 deletions
@@ -22,7 +22,7 @@ goog.require('ol.css');
 * @constructor
 * @extends {ol.control.Control}
 * @param {olx.control.AttributionOptions=} opt_options Attribution options.
- * @todo api
+ * @api
 */
 ol.control.Attribution = function(opt_options) {

@@ -34,7 +34,7 @@ goog.require('ol.Object');
 * @extends {ol.Object}
 * @implements {oli.control.Control}
 * @param {olx.control.ControlOptions} options Control options.
- * @todo api stable
+ * @api stable
 */
 ol.control.Control = function(options) {

@@ -81,7 +81,7 @@ ol.control.Control.prototype.disposeInternal = function() {
 /**
 * Get the map associated with this control.
 * @return {ol.Map} Map.
- * @todo api
+ * @api
 */
 ol.control.Control.prototype.getMap = function() {
  return this.map_;
@@ -102,7 +102,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 api stable
+ * @api stable
 */
 ol.control.Control.prototype.setMap = function(map) {
  if (!goog.isNull(this.map_)) {
@@ -19,7 +19,7 @@ goog.require('ol.control.Zoom');
 *
 * @param {olx.control.DefaultsOptions=} opt_options Defaults options.
 * @return {ol.Collection} Controls.
- * @todo api
+ * @api
 */
 ol.control.defaults = function(opt_options) {

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

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

@@ -37,7 +37,7 @@ ol.control.MousePositionProperty = {
 * @extends {ol.control.Control}
 * @param {olx.control.MousePositionOptions=} opt_options Mouse position
 *     options.
- * @todo api
+ * @api
 */
 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.
 * @todo observable
- * @todo api
+ * @api
 */
 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.
 * @todo observable
- * @todo api
+ * @api
 */
 ol.control.MousePosition.prototype.getProjection = function() {
  return /** @type {ol.proj.Projection|undefined} */ (
@@ -183,7 +183,7 @@ ol.control.MousePosition.prototype.handleMouseOut = function(browserEvent) {

 /**
 * @inheritDoc
- * @todo api
+ * @api
 */
 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.
 * @todo observable
- * @todo api
+ * @api
 */
 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.
 * @todo observable
- * @todo api
+ * @api
 */
 ol.control.MousePosition.prototype.setProjection = function(projection) {
  this.set(ol.control.MousePositionProperty.PROJECTION, projection);
@@ -21,7 +21,7 @@ goog.require('ol.pointer.PointerEventHandler');
 * @constructor
 * @extends {ol.control.Control}
 * @param {olx.control.RotateOptions=} opt_options Rotate options.
- * @todo api
+ * @api
 */
 ol.control.Rotate = function(opt_options) {

@@ -29,7 +29,7 @@ ol.control.ScaleLineProperty = {
 * Units for the scale line. Supported values are `'degrees'`, `'imperial'`,
 * `'nautical'`, `'metric'`, `'us'`.
 * @enum {string}
- * @todo api
+ * @api
 */
 ol.control.ScaleLineUnits = {
  DEGREES: 'degrees',
@@ -50,7 +50,7 @@ ol.control.ScaleLineUnits = {
 * @constructor
 * @extends {ol.control.Control}
 * @param {olx.control.ScaleLineOptions=} opt_options Scale line options.
- * @todo api
+ * @api
 */
 ol.control.ScaleLine = function(opt_options) {

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

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

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