Use @api annotation instead of @todo api

This commit is contained in:
Tim Schaub
2014-07-05 15:41:14 -04:00
parent 297503e7c9
commit 4cf5ab4620
155 changed files with 759 additions and 757 deletions

View File

@@ -25,7 +25,7 @@ goog.require('ol.renderer.vector');
*
* @constructor
* @param {olx.FeatureOverlayOptions=} opt_options Options.
* @todo api
* @api
*/
ol.FeatureOverlay = function(opt_options) {
@@ -97,7 +97,7 @@ ol.FeatureOverlay = function(opt_options) {
/**
* @param {ol.Feature} feature Feature.
* @todo api
* @api
*/
ol.FeatureOverlay.prototype.addFeature = function(feature) {
this.features_.push(feature);
@@ -106,7 +106,7 @@ ol.FeatureOverlay.prototype.addFeature = function(feature) {
/**
* @return {ol.Collection} Features collection.
* @todo api
* @api
*/
ol.FeatureOverlay.prototype.getFeatures = function() {
return this.features_;
@@ -195,7 +195,7 @@ ol.FeatureOverlay.prototype.handleMapPostCompose_ = function(event) {
/**
* @param {ol.Feature} feature Feature.
* @todo api
* @api
*/
ol.FeatureOverlay.prototype.removeFeature = function(feature) {
this.features_.remove(feature);
@@ -214,7 +214,7 @@ ol.FeatureOverlay.prototype.render_ = function() {
/**
* @param {ol.Collection} features Features collection.
* @todo api
* @api
*/
ol.FeatureOverlay.prototype.setFeatures = function(features) {
if (!goog.isNull(this.featuresListenerKeys_)) {
@@ -248,7 +248,7 @@ ol.FeatureOverlay.prototype.setFeatures = function(features) {
/**
* @param {ol.Map} map Map.
* @todo api
* @api
*/
ol.FeatureOverlay.prototype.setMap = function(map) {
if (!goog.isNull(this.postComposeListenerKey_)) {
@@ -272,7 +272,7 @@ ol.FeatureOverlay.prototype.setMap = function(map) {
* an array of styles.
* @param {ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction} style
* Overlay style.
* @todo api
* @api
*/
ol.FeatureOverlay.prototype.setStyle = function(style) {
this.style_ = style;
@@ -286,7 +286,7 @@ ol.FeatureOverlay.prototype.setStyle = function(style) {
* option at construction or to the `setStyle` method.
* @return {ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction}
* Overlay style.
* @todo api
* @api
*/
ol.FeatureOverlay.prototype.getStyle = function() {
return this.style_;
@@ -296,7 +296,7 @@ ol.FeatureOverlay.prototype.getStyle = function() {
/**
* Get the style function.
* @return {ol.feature.StyleFunction|undefined} Style function.
* @todo api
* @api
*/
ol.FeatureOverlay.prototype.getStyleFunction = function() {
return this.styleFunction_;