Annotations for exports

2014-04-08 13:40:35 -06:00
parent 457cfe851a
commit fb497f5288
243 changed files with 456 additions and 451 deletions
--- a/src/ol/style/circlestyle.exports
+++ b/src/ol/style/circlestyle.exports
@@ -1,7 +0,0 @@
-@exportSymbol ol.style.Circle
-@exportProperty ol.style.Circle.prototype.getAnchor
-@exportProperty ol.style.Circle.prototype.getFill
-@exportProperty ol.style.Circle.prototype.getImage
-@exportProperty ol.style.Circle.prototype.getRadius
-@exportProperty ol.style.Circle.prototype.getSize
-@exportProperty ol.style.Circle.prototype.getStroke
--- a/src/ol/style/circlestyle.js
+++ b/src/ol/style/circlestyle.js
@@ -18,6 +18,7 @@ goog.require('ol.style.Stroke');
 * @param {olx.style.CircleOptions=} opt_options Options.
 * @extends {ol.style.Image}
 * @todo stability experimental
+ * @todo api
 */
 ol.style.Circle = function(opt_options) {

@@ -82,6 +83,7 @@ goog.inherits(ol.style.Circle, ol.style.Image);

 /**
 * @inheritDoc
+ * @todo api
 */
 ol.style.Circle.prototype.getAnchor = function() {
  return this.anchor_;
@@ -90,6 +92,7 @@ ol.style.Circle.prototype.getAnchor = function() {

 /**
 * @return {ol.style.Fill} Fill style.
+ * @todo api
 */
 ol.style.Circle.prototype.getFill = function() {
  return this.fill_;
@@ -106,6 +109,7 @@ ol.style.Circle.prototype.getHitDetectionImage = function(pixelRatio) {

 /**
 * @inheritDoc
+ * @todo api
 */
 ol.style.Circle.prototype.getImage = function(pixelRatio) {
  return this.canvas_;
@@ -122,6 +126,7 @@ ol.style.Circle.prototype.getImageState = function() {

 /**
 * @return {number} Radius.
+ * @todo api
 */
 ol.style.Circle.prototype.getRadius = function() {
  return this.radius_;
@@ -130,6 +135,7 @@ ol.style.Circle.prototype.getRadius = function() {

 /**
 * @inheritDoc
+ * @todo api
 */
 ol.style.Circle.prototype.getSize = function() {
  return this.size_;
@@ -138,6 +144,7 @@ ol.style.Circle.prototype.getSize = function() {

 /**
 * @return {ol.style.Stroke} Stroke style.
+ * @todo api
 */
 ol.style.Circle.prototype.getStroke = function() {
  return this.stroke_;
--- a/src/ol/style/fillstyle.exports
+++ b/src/ol/style/fillstyle.exports
@@ -1,2 +0,0 @@
-@exportSymbol ol.style.Fill
-@exportProperty ol.style.Fill.prototype.getColor
--- a/src/ol/style/fillstyle.js
+++ b/src/ol/style/fillstyle.js
@@ -7,6 +7,7 @@ goog.require('ol.color');
 /**
 * @constructor
 * @param {olx.style.FillOptions=} opt_options Options.
+ * @todo api
 */
 ol.style.Fill = function(opt_options) {

@@ -22,6 +23,7 @@ ol.style.Fill = function(opt_options) {

 /**
 * @return {ol.Color|string} Color.
+ * @todo api
 */
 ol.style.Fill.prototype.getColor = function() {
  return this.color_;
--- a/src/ol/style/iconstyle.exports
+++ b/src/ol/style/iconstyle.exports
@@ -1,5 +0,0 @@
-@exportSymbol ol.style.Icon
-@exportProperty ol.style.Icon.prototype.getAnchor
-@exportProperty ol.style.Icon.prototype.getImage
-@exportProperty ol.style.Icon.prototype.getSize
-@exportProperty ol.style.Icon.prototype.getSrc
--- a/src/ol/style/iconstyle.js
+++ b/src/ol/style/iconstyle.js
@@ -40,6 +40,7 @@ ol.style.IconAnchorUnits = {
 * @constructor
 * @param {olx.style.IconOptions=} opt_options Options.
 * @extends {ol.style.Image}
+ * @todo api
 */
 ol.style.Icon = function(opt_options) {

@@ -125,6 +126,7 @@ goog.inherits(ol.style.Icon, ol.style.Image);

 /**
 * @inheritDoc
+ * @todo api
 */
 ol.style.Icon.prototype.getAnchor = function() {
  var anchor = this.anchor_;
@@ -165,6 +167,7 @@ ol.style.Icon.prototype.getAnchor = function() {

 /**
 * @inheritDoc
+ * @todo api
 */
 ol.style.Icon.prototype.getImage = function(pixelRatio) {
  return this.iconImage_.getImage(pixelRatio);
@@ -189,6 +192,7 @@ ol.style.Icon.prototype.getHitDetectionImage = function(pixelRatio) {

 /**
 * @return {string|undefined} Image src.
+ * @todo api
 */
 ol.style.Icon.prototype.getSrc = function() {
  return this.iconImage_.getSrc();
@@ -197,6 +201,7 @@ ol.style.Icon.prototype.getSrc = function() {

 /**
 * @inheritDoc
+ * @todo api
 */
 ol.style.Icon.prototype.getSize = function() {
  return goog.isNull(this.size_) ? this.iconImage_.getSize() : this.size_;
--- a/src/ol/style/imagestyle.exports
+++ b/src/ol/style/imagestyle.exports
@@ -1,3 +0,0 @@
-@exportSymbol ol.style.Image
-@exportProperty ol.style.Image.prototype.getRotation
-@exportProperty ol.style.Image.prototype.getScale
--- a/src/ol/style/imagestyle.js
+++ b/src/ol/style/imagestyle.js
@@ -29,6 +29,7 @@ ol.style.ImageOptions;
 /**
 * @constructor
 * @param {ol.style.ImageOptions} options Options.
+ * @todo api
 */
 ol.style.Image = function(options) {

@@ -83,6 +84,7 @@ ol.style.Image.prototype.getRotateWithView = function() {

 /**
 * @return {number} Rotation.
+ * @todo api
 */
 ol.style.Image.prototype.getRotation = function() {
  return this.rotation_;
@@ -91,6 +93,7 @@ ol.style.Image.prototype.getRotation = function() {

 /**
 * @return {number} Scale.
+ * @todo api
 */
 ol.style.Image.prototype.getScale = function() {
  return this.scale_;
--- a/src/ol/style/strokestyle.exports
+++ b/src/ol/style/strokestyle.exports
@@ -1,7 +0,0 @@
-@exportSymbol ol.style.Stroke
-@exportProperty ol.style.Stroke.prototype.getColor
-@exportProperty ol.style.Stroke.prototype.getLineCap
-@exportProperty ol.style.Stroke.prototype.getLineDash
-@exportProperty ol.style.Stroke.prototype.getLineJoin
-@exportProperty ol.style.Stroke.prototype.getMiterLimit
-@exportProperty ol.style.Stroke.prototype.getWidth
--- a/src/ol/style/strokestyle.js
+++ b/src/ol/style/strokestyle.js
@@ -7,6 +7,7 @@ goog.require('ol.color');
 /**
 * @constructor
 * @param {olx.style.StrokeOptions=} opt_options Options.
+ * @todo api
 */
 ol.style.Stroke = function(opt_options) {

@@ -52,6 +53,7 @@ ol.style.Stroke = function(opt_options) {

 /**
 * @return {ol.Color|string} Color.
+ * @todo api
 */
 ol.style.Stroke.prototype.getColor = function() {
  return this.color_;
@@ -60,6 +62,7 @@ ol.style.Stroke.prototype.getColor = function() {

 /**
 * @return {string|undefined} Line cap.
+ * @todo api
 */
 ol.style.Stroke.prototype.getLineCap = function() {
  return this.lineCap_;
@@ -68,6 +71,7 @@ ol.style.Stroke.prototype.getLineCap = function() {

 /**
 * @return {Array.<number>} Line dash.
+ * @todo api
 */
 ol.style.Stroke.prototype.getLineDash = function() {
  return this.lineDash_;
@@ -76,6 +80,7 @@ ol.style.Stroke.prototype.getLineDash = function() {

 /**
 * @return {string|undefined} Line join.
+ * @todo api
 */
 ol.style.Stroke.prototype.getLineJoin = function() {
  return this.lineJoin_;
@@ -84,6 +89,7 @@ ol.style.Stroke.prototype.getLineJoin = function() {

 /**
 * @return {number|undefined} Miter limit.
+ * @todo api
 */
 ol.style.Stroke.prototype.getMiterLimit = function() {
  return this.miterLimit_;
@@ -92,6 +98,7 @@ ol.style.Stroke.prototype.getMiterLimit = function() {

 /**
 * @return {number|undefined} Width.
+ * @todo api
 */
 ol.style.Stroke.prototype.getWidth = function() {
  return this.width_;
--- a/src/ol/style/style.exports
+++ b/src/ol/style/style.exports
@@ -1,6 +0,0 @@
-@exportSymbol ol.style.Style
-@exportProperty ol.style.Style.prototype.getFill
-@exportProperty ol.style.Style.prototype.getImage
-@exportProperty ol.style.Style.prototype.getStroke
-@exportProperty ol.style.Style.prototype.getText
-@exportProperty ol.style.Style.prototype.getZIndex
--- a/src/ol/style/style.js
+++ b/src/ol/style/style.js
@@ -9,6 +9,7 @@ goog.require('ol.style.Image');
 * @constructor
 * @param {olx.style.StyleOptions=} opt_options Style options.
 * @todo stability experimental
+ * @todo api
 */
 ol.style.Style = function(opt_options) {

@@ -49,6 +50,7 @@ ol.style.Style = function(opt_options) {

 /**
 * @return {ol.style.Fill} Fill style.
+ * @todo api
 */
 ol.style.Style.prototype.getFill = function() {
  return this.fill_;
@@ -57,6 +59,7 @@ ol.style.Style.prototype.getFill = function() {

 /**
 * @return {ol.style.Image} Image style.
+ * @todo api
 */
 ol.style.Style.prototype.getImage = function() {
  return this.image_;
@@ -65,6 +68,7 @@ ol.style.Style.prototype.getImage = function() {

 /**
 * @return {ol.style.Stroke} Stroke style.
+ * @todo api
 */
 ol.style.Style.prototype.getStroke = function() {
  return this.stroke_;
@@ -73,6 +77,7 @@ ol.style.Style.prototype.getStroke = function() {

 /**
 * @return {ol.style.Text} Text style.
+ * @todo api
 */
 ol.style.Style.prototype.getText = function() {
  return this.text_;
@@ -81,6 +86,7 @@ ol.style.Style.prototype.getText = function() {

 /**
 * @return {number|undefined} ZIndex.
+ * @todo api
 */
 ol.style.Style.prototype.getZIndex = function() {
  return this.zIndex_;
--- a/src/ol/style/textstyle.exports
+++ b/src/ol/style/textstyle.exports
@@ -1,9 +0,0 @@
-@exportSymbol ol.style.Text
-@exportProperty ol.style.Text.prototype.getFill
-@exportProperty ol.style.Text.prototype.getFont
-@exportProperty ol.style.Text.prototype.getRotation
-@exportProperty ol.style.Text.prototype.getScale
-@exportProperty ol.style.Text.prototype.getStroke
-@exportProperty ol.style.Text.prototype.getText
-@exportProperty ol.style.Text.prototype.getTextAlign
-@exportProperty ol.style.Text.prototype.getTextBaseline
--- a/src/ol/style/textstyle.js
+++ b/src/ol/style/textstyle.js
@@ -5,6 +5,7 @@ goog.provide('ol.style.Text');
 /**
 * @constructor
 * @param {olx.style.TextOptions=} opt_options Options.
+ * @todo api
 */
 ol.style.Text = function(opt_options) {

@@ -74,6 +75,7 @@ ol.style.Text = function(opt_options) {

 /**
 * @return {string|undefined} Font.
+ * @todo api
 */
 ol.style.Text.prototype.getFont = function() {
  return this.font_;
@@ -98,6 +100,7 @@ ol.style.Text.prototype.getOffsetY = function() {

 /**
 * @return {ol.style.Fill} Fill style.
+ * @todo api
 */
 ol.style.Text.prototype.getFill = function() {
  return this.fill_;
@@ -106,6 +109,7 @@ ol.style.Text.prototype.getFill = function() {

 /**
 * @return {number|undefined} Rotation.
+ * @todo api
 */
 ol.style.Text.prototype.getRotation = function() {
  return this.rotation_;
@@ -114,6 +118,7 @@ ol.style.Text.prototype.getRotation = function() {

 /**
 * @return {number|undefined} Scale.
+ * @todo api
 */
 ol.style.Text.prototype.getScale = function() {
  return this.scale_;
@@ -122,6 +127,7 @@ ol.style.Text.prototype.getScale = function() {

 /**
 * @return {ol.style.Stroke} Stroke style.
+ * @todo api
 */
 ol.style.Text.prototype.getStroke = function() {
  return this.stroke_;
@@ -130,6 +136,7 @@ ol.style.Text.prototype.getStroke = function() {

 /**
 * @return {string|undefined} Text.
+ * @todo api
 */
 ol.style.Text.prototype.getText = function() {
  return this.text_;
@@ -138,6 +145,7 @@ ol.style.Text.prototype.getText = function() {

 /**
 * @return {string|undefined} Text align.
+ * @todo api
 */
 ol.style.Text.prototype.getTextAlign = function() {
  return this.textAlign_;
@@ -146,6 +154,7 @@ ol.style.Text.prototype.getTextAlign = function() {

 /**
 * @return {string|undefined} Text baseline.
+ * @todo api
 */
 ol.style.Text.prototype.getTextBaseline = function() {
  return this.textBaseline_;