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
+1 -1
View File
@@ -28,7 +28,7 @@ ol.layer.HeatmapLayerProperty = {
* @extends {ol.layer.Vector}
* @fires ol.render.Event
* @param {olx.layer.HeatmapOptions=} opt_options Options.
* @todo api
* @api
*/
ol.layer.Heatmap = function(opt_options) {
var options = goog.isDef(opt_options) ? opt_options : {};
+1 -1
View File
@@ -13,7 +13,7 @@ goog.require('ol.layer.Layer');
* @extends {ol.layer.Layer}
* @fires ol.render.Event
* @param {olx.layer.LayerOptions} options Layer options.
* @todo api
* @api
*/
ol.layer.Image = function(options) {
goog.base(this, options);
+2 -2
View File
@@ -22,7 +22,7 @@ goog.require('ol.source.Source');
* @fires ol.render.Event
* @fires change Triggered when the state of the source changes.
* @param {olx.layer.LayerOptions} options Layer options.
* @todo api
* @api
*/
ol.layer.Layer = function(options) {
@@ -80,7 +80,7 @@ ol.layer.Layer.prototype.getLayerStatesArray = function(opt_states) {
/**
* @return {ol.source.Source} Source.
* @todo api
* @api
*/
ol.layer.Layer.prototype.getSource = function() {
return this.source_;
+16 -16
View File
@@ -86,7 +86,7 @@ goog.inherits(ol.layer.Base, ol.Object);
/**
* @return {number|undefined} The brightness of the layer.
* @todo observable
* @todo api
* @api
*/
ol.layer.Base.prototype.getBrightness = function() {
return /** @type {number|undefined} */ (
@@ -101,7 +101,7 @@ goog.exportProperty(
/**
* @return {number|undefined} The contrast of the layer.
* @todo observable
* @todo api
* @api
*/
ol.layer.Base.prototype.getContrast = function() {
return /** @type {number|undefined} */ (
@@ -116,7 +116,7 @@ goog.exportProperty(
/**
* @return {number|undefined} The hue of the layer.
* @todo observable
* @todo api
* @api
*/
ol.layer.Base.prototype.getHue = function() {
return /** @type {number|undefined} */ (this.get(ol.layer.LayerProperty.HUE));
@@ -174,7 +174,7 @@ ol.layer.Base.prototype.getLayerStatesArray = goog.abstractMethod;
/**
* @return {number|undefined} The maximum resolution of the layer.
* @todo observable
* @todo api
* @api
*/
ol.layer.Base.prototype.getMaxResolution = function() {
return /** @type {number|undefined} */ (
@@ -189,7 +189,7 @@ goog.exportProperty(
/**
* @return {number|undefined} The minimum resolution of the layer.
* @todo observable
* @todo api
* @api
*/
ol.layer.Base.prototype.getMinResolution = function() {
return /** @type {number|undefined} */ (
@@ -204,7 +204,7 @@ goog.exportProperty(
/**
* @return {number|undefined} The opacity of the layer.
* @todo observable
* @todo api
* @api
*/
ol.layer.Base.prototype.getOpacity = function() {
return /** @type {number|undefined} */ (
@@ -219,7 +219,7 @@ goog.exportProperty(
/**
* @return {number|undefined} The saturation of the layer.
* @todo observable
* @todo api
* @api
*/
ol.layer.Base.prototype.getSaturation = function() {
return /** @type {number|undefined} */ (
@@ -240,7 +240,7 @@ ol.layer.Base.prototype.getSourceState = goog.abstractMethod;
/**
* @return {boolean|undefined} The visiblity of the layer.
* @todo observable
* @todo api
* @api
*/
ol.layer.Base.prototype.getVisible = function() {
return /** @type {boolean|undefined} */ (
@@ -272,7 +272,7 @@ goog.exportProperty(
*
* @param {number|undefined} brightness The brightness of the layer.
* @todo observable
* @todo api
* @api
*/
ol.layer.Base.prototype.setBrightness = function(brightness) {
this.set(ol.layer.LayerProperty.BRIGHTNESS, brightness);
@@ -290,7 +290,7 @@ goog.exportProperty(
*
* @param {number|undefined} contrast The contrast of the layer.
* @todo observable
* @todo api
* @api
*/
ol.layer.Base.prototype.setContrast = function(contrast) {
this.set(ol.layer.LayerProperty.CONTRAST, contrast);
@@ -306,7 +306,7 @@ goog.exportProperty(
* unchanged. Other values are radians around the color circle.
* @param {number|undefined} hue The hue of the layer.
* @todo observable
* @todo api
* @api
*/
ol.layer.Base.prototype.setHue = function(hue) {
this.set(ol.layer.LayerProperty.HUE, hue);
@@ -320,7 +320,7 @@ goog.exportProperty(
/**
* @param {number|undefined} maxResolution The maximum resolution of the layer.
* @todo observable
* @todo api
* @api
*/
ol.layer.Base.prototype.setMaxResolution = function(maxResolution) {
this.set(ol.layer.LayerProperty.MAX_RESOLUTION, maxResolution);
@@ -334,7 +334,7 @@ goog.exportProperty(
/**
* @param {number|undefined} minResolution The minimum resolution of the layer.
* @todo observable
* @todo api
* @api
*/
ol.layer.Base.prototype.setMinResolution = function(minResolution) {
this.set(ol.layer.LayerProperty.MIN_RESOLUTION, minResolution);
@@ -348,7 +348,7 @@ goog.exportProperty(
/**
* @param {number|undefined} opacity The opacity of the layer.
* @todo observable
* @todo api
* @api
*/
ol.layer.Base.prototype.setOpacity = function(opacity) {
this.set(ol.layer.LayerProperty.OPACITY, opacity);
@@ -367,7 +367,7 @@ goog.exportProperty(
*
* @param {number|undefined} saturation The saturation of the layer.
* @todo observable
* @todo api
* @api
*/
ol.layer.Base.prototype.setSaturation = function(saturation) {
this.set(ol.layer.LayerProperty.SATURATION, saturation);
@@ -381,7 +381,7 @@ goog.exportProperty(
/**
* @param {boolean|undefined} visible The visiblity of the layer.
* @todo observable
* @todo api
* @api
*/
ol.layer.Base.prototype.setVisible = function(visible) {
this.set(ol.layer.LayerProperty.VISIBLE, visible);
+1 -1
View File
@@ -33,7 +33,7 @@ ol.layer.GroupProperty = {
* @fires change Triggered when the state of the source of any of the layers of
* this group changes
* @param {olx.layer.GroupOptions=} opt_options Layer options.
* @todo api
* @api
*/
ol.layer.Group = function(opt_options) {
+1 -1
View File
@@ -22,7 +22,7 @@ ol.layer.TileProperty = {
* @extends {ol.layer.Layer}
* @fires ol.render.Event
* @param {olx.layer.TileOptions} options Tile layer options.
* @todo api
* @api
*/
ol.layer.Tile = function(options) {
goog.base(this, options);
+4 -4
View File
@@ -22,7 +22,7 @@ ol.layer.VectorProperty = {
* @extends {ol.layer.Layer}
* @fires ol.render.Event
* @param {olx.layer.VectorOptions=} opt_options Options.
* @todo api
* @api
*/
ol.layer.Vector = function(opt_options) {
@@ -71,7 +71,7 @@ ol.layer.Vector.prototype.getRenderOrder = function() {
* option at construction or to the `setStyle` method.
* @return {ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction}
* Layer style.
* @todo api
* @api
*/
ol.layer.Vector.prototype.getStyle = function() {
return this.style_;
@@ -81,7 +81,7 @@ ol.layer.Vector.prototype.getStyle = function() {
/**
* Get the style function.
* @return {ol.feature.StyleFunction|undefined} Layer style function.
* @todo api
* @api
*/
ol.layer.Vector.prototype.getStyleFunction = function() {
return this.styleFunction_;
@@ -103,7 +103,7 @@ ol.layer.Vector.prototype.setRenderOrder = function(renderOrder) {
* an array of styles.
* @param {ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction} style
* Layer style.
* @todo api
* @api
*/
ol.layer.Vector.prototype.setStyle = function(style) {
this.style_ = style;