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

Use @api annotation instead of @todo api

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files
src/ol/style/circlestyle.js
+8 -8
View File
@@ -18,7 +18,7 @@ goog.require('ol.style.Stroke');
* @constructor
* @param {olx.style.CircleOptions=} opt_options Options.
* @extends {ol.style.Image}
* @todo api
* @api
*/
ol.style.Circle = function(opt_options) {
@@ -95,7 +95,7 @@ goog.inherits(ol.style.Circle, ol.style.Image);
/**
* @inheritDoc
* @todo api
* @api
*/
ol.style.Circle.prototype.getAnchor = function() {
return this.anchor_;
@@ -104,7 +104,7 @@ ol.style.Circle.prototype.getAnchor = function() {
/**
* @return {ol.style.Fill} Fill style.
* @todo api
* @api
*/
ol.style.Circle.prototype.getFill = function() {
return this.fill_;
@@ -121,7 +121,7 @@ ol.style.Circle.prototype.getHitDetectionImage = function(pixelRatio) {
/**
* @inheritDoc
* @todo api
* @api
*/
ol.style.Circle.prototype.getImage = function(pixelRatio) {
return this.canvas_;
@@ -138,7 +138,7 @@ ol.style.Circle.prototype.getImageState = function() {
/**
* @inheritDoc
* @todo api
* @api
*/
ol.style.Circle.prototype.getOrigin = function() {
return this.origin_;
@@ -147,7 +147,7 @@ ol.style.Circle.prototype.getOrigin = function() {
/**
* @return {number} Radius.
* @todo api
* @api
*/
ol.style.Circle.prototype.getRadius = function() {
return this.radius_;
@@ -156,7 +156,7 @@ ol.style.Circle.prototype.getRadius = function() {
/**
* @inheritDoc
* @todo api
* @api
*/
ol.style.Circle.prototype.getSize = function() {
return this.size_;
@@ -165,7 +165,7 @@ ol.style.Circle.prototype.getSize = function() {
/**
* @return {ol.style.Stroke} Stroke style.
* @todo api
* @api
*/
ol.style.Circle.prototype.getStroke = function() {
return this.stroke_;
src/ol/style/fillstyle.js
+2 -2
View File
@@ -10,7 +10,7 @@ goog.require('ol.color');
*
* @constructor
* @param {olx.style.FillOptions=} opt_options Options.
* @todo api
* @api
*/
ol.style.Fill = function(opt_options) {
@@ -26,7 +26,7 @@ ol.style.Fill = function(opt_options) {
/**
* @return {ol.Color|string} Color.
* @todo api
* @api
*/
ol.style.Fill.prototype.getColor = function() {
return this.color_;
src/ol/style/iconstyle.js
+6 -6
View File
@@ -41,7 +41,7 @@ ol.style.IconOrigin = {
* @constructor
* @param {olx.style.IconOptions=} opt_options Options.
* @extends {ol.style.Image}
* @todo api
* @api
*/
ol.style.Icon = function(opt_options) {
@@ -180,7 +180,7 @@ goog.inherits(ol.style.Icon, ol.style.Image);
/**
* @inheritDoc
* @todo api
* @api
*/
ol.style.Icon.prototype.getAnchor = function() {
if (!goog.isNull(this.normalizedAnchor_)) {
@@ -225,7 +225,7 @@ ol.style.Icon.prototype.getAnchor = function() {
/**
* @inheritDoc
* @todo api
* @api
*/
ol.style.Icon.prototype.getImage = function(pixelRatio) {
return this.iconImage_.getImage(pixelRatio);
@@ -259,7 +259,7 @@ ol.style.Icon.prototype.getHitDetectionImage = function(pixelRatio) {
/**
* @inheritDoc
* @todo api
* @api
*/
ol.style.Icon.prototype.getOrigin = function() {
if (!goog.isNull(this.origin_)) {
@@ -290,7 +290,7 @@ ol.style.Icon.prototype.getOrigin = function() {
/**
* @return {string|undefined} Image src.
* @todo api
* @api
*/
ol.style.Icon.prototype.getSrc = function() {
return this.iconImage_.getSrc();
@@ -299,7 +299,7 @@ ol.style.Icon.prototype.getSrc = function() {
/**
* @inheritDoc
* @todo api
* @api
*/
ol.style.Icon.prototype.getSize = function() {
return goog.isNull(this.size_) ? this.iconImage_.getSize() : this.size_;
src/ol/style/imagestyle.js
+2 -2
View File
@@ -84,7 +84,7 @@ ol.style.Image.prototype.getRotateWithView = function() {
/**
* @return {number} Rotation.
* @todo api
* @api
*/
ol.style.Image.prototype.getRotation = function() {
return this.rotation_;
@@ -93,7 +93,7 @@ ol.style.Image.prototype.getRotation = function() {
/**
* @return {number} Scale.
* @todo api
* @api
*/
ol.style.Image.prototype.getScale = function() {
return this.scale_;
src/ol/style/strokestyle.js
+7 -7
View File
@@ -10,7 +10,7 @@ goog.require('ol.color');
*
* @constructor
* @param {olx.style.StrokeOptions=} opt_options Options.
* @todo api
* @api
*/
ol.style.Stroke = function(opt_options) {
@@ -56,7 +56,7 @@ ol.style.Stroke = function(opt_options) {
/**
* @return {ol.Color|string} Color.
* @todo api
* @api
*/
ol.style.Stroke.prototype.getColor = function() {
return this.color_;
@@ -65,7 +65,7 @@ ol.style.Stroke.prototype.getColor = function() {
/**
* @return {string|undefined} Line cap.
* @todo api
* @api
*/
ol.style.Stroke.prototype.getLineCap = function() {
return this.lineCap_;
@@ -74,7 +74,7 @@ ol.style.Stroke.prototype.getLineCap = function() {
/**
* @return {Array.<number>} Line dash.
* @todo api
* @api
*/
ol.style.Stroke.prototype.getLineDash = function() {
return this.lineDash_;
@@ -83,7 +83,7 @@ ol.style.Stroke.prototype.getLineDash = function() {
/**
* @return {string|undefined} Line join.
* @todo api
* @api
*/
ol.style.Stroke.prototype.getLineJoin = function() {
return this.lineJoin_;
@@ -92,7 +92,7 @@ ol.style.Stroke.prototype.getLineJoin = function() {
/**
* @return {number|undefined} Miter limit.
* @todo api
* @api
*/
ol.style.Stroke.prototype.getMiterLimit = function() {
return this.miterLimit_;
@@ -101,7 +101,7 @@ ol.style.Stroke.prototype.getMiterLimit = function() {
/**
* @return {number|undefined} Width.
* @todo api
* @api
*/
ol.style.Stroke.prototype.getWidth = function() {
return this.width_;
src/ol/style/style.js
+6 -6
View File
@@ -11,7 +11,7 @@ goog.require('ol.style.Image');
*
* @constructor
* @param {olx.style.StyleOptions=} opt_options Style options.
* @todo api
* @api
*/
ol.style.Style = function(opt_options) {
@@ -52,7 +52,7 @@ ol.style.Style = function(opt_options) {
/**
* @return {ol.style.Fill} Fill style.
* @todo api
* @api
*/
ol.style.Style.prototype.getFill = function() {
return this.fill_;
@@ -61,7 +61,7 @@ ol.style.Style.prototype.getFill = function() {
/**
* @return {ol.style.Image} Image style.
* @todo api
* @api
*/
ol.style.Style.prototype.getImage = function() {
return this.image_;
@@ -70,7 +70,7 @@ ol.style.Style.prototype.getImage = function() {
/**
* @return {ol.style.Stroke} Stroke style.
* @todo api
* @api
*/
ol.style.Style.prototype.getStroke = function() {
return this.stroke_;
@@ -79,7 +79,7 @@ ol.style.Style.prototype.getStroke = function() {
/**
* @return {ol.style.Text} Text style.
* @todo api
* @api
*/
ol.style.Style.prototype.getText = function() {
return this.text_;
@@ -88,7 +88,7 @@ ol.style.Style.prototype.getText = function() {
/**
* @return {number|undefined} ZIndex.
* @todo api
* @api
*/
ol.style.Style.prototype.getZIndex = function() {
return this.zIndex_;
src/ol/style/textstyle.js
+9 -9
View File
@@ -8,7 +8,7 @@ goog.provide('ol.style.Text');
*
* @constructor
* @param {olx.style.TextOptions=} opt_options Options.
* @todo api
* @api
*/
ol.style.Text = function(opt_options) {
@@ -78,7 +78,7 @@ ol.style.Text = function(opt_options) {
/**
* @return {string|undefined} Font.
* @todo api
* @api
*/
ol.style.Text.prototype.getFont = function() {
return this.font_;
@@ -103,7 +103,7 @@ ol.style.Text.prototype.getOffsetY = function() {
/**
* @return {ol.style.Fill} Fill style.
* @todo api
* @api
*/
ol.style.Text.prototype.getFill = function() {
return this.fill_;
@@ -112,7 +112,7 @@ ol.style.Text.prototype.getFill = function() {
/**
* @return {number|undefined} Rotation.
* @todo api
* @api
*/
ol.style.Text.prototype.getRotation = function() {
return this.rotation_;
@@ -121,7 +121,7 @@ ol.style.Text.prototype.getRotation = function() {
/**
* @return {number|undefined} Scale.
* @todo api
* @api
*/
ol.style.Text.prototype.getScale = function() {
return this.scale_;
@@ -130,7 +130,7 @@ ol.style.Text.prototype.getScale = function() {
/**
* @return {ol.style.Stroke} Stroke style.
* @todo api
* @api
*/
ol.style.Text.prototype.getStroke = function() {
return this.stroke_;
@@ -139,7 +139,7 @@ ol.style.Text.prototype.getStroke = function() {
/**
* @return {string|undefined} Text.
* @todo api
* @api
*/
ol.style.Text.prototype.getText = function() {
return this.text_;
@@ -148,7 +148,7 @@ ol.style.Text.prototype.getText = function() {
/**
* @return {string|undefined} Text align.
* @todo api
* @api
*/
ol.style.Text.prototype.getTextAlign = function() {
return this.textAlign_;
@@ -157,7 +157,7 @@ ol.style.Text.prototype.getTextAlign = function() {
/**
* @return {string|undefined} Text baseline.
* @todo api
* @api
*/
ol.style.Text.prototype.getTextBaseline = function() {
return this.textBaseline_;