Doc improvements

src/ol/style/fillstyle.js

@@ -32,8 +32,8 @@ ol.style.Fill.prototype.getColor = function() {
 
 
 /**
- * Set the color. Use `setStyle()` on the feature, layer or feature overlay
+ * Set the color. Call `setStyle()` or `dispatchChangeEvent()` on feature, layer
- * for changes to take effect.
+ * or feature overlay for changes to take effect.
  *
  * @param {ol.Color|string} color Color.
  * @api

src/ol/style/imagestyle.js

@@ -151,8 +151,8 @@ ol.style.Image.prototype.getSize = goog.abstractMethod;
 
 
 /**
- * Set the zIndex. Use `setStyle()` on the feature, layer or feature overlay
+ * Set the zIndex. Call `setStyle()` or `dispatchChangeEvent()` on feature,
- * for changes to take effect.
+ * layer or feature overlay for changes to take effect.
  *
  * @param {number} opacity Opacity.
  */
@@ -162,8 +162,9 @@ ol.style.Image.prototype.setOpacity = function(opacity) {
 
 
 /**
- * Set whether to rotate the style with the view. Use `setStyle()` on the
+ * Set whether to rotate the style with the view. Call `setStyle()` or
- * feature, layer or feature overlay for changes to take effect.
+ * `dispatchChangeEvent()` on  feature, layer or feature overlay for changes to
+ * take effect.
  *
  * @param {boolean} rotateWithView Rotate with map.
  */
@@ -173,8 +174,8 @@ ol.style.Image.prototype.setRotateWithView = function(rotateWithView) {
 
 
 /**
- * Set the rotation. Use `setStyle()` on the feature, layer or feature overlay
+ * Set the rotation. Call `setStyle()` or `dispatchChangeEvent()` on feature,
- * for changes to take effect.
+ * layer or feature overlay for changes to take effect.
  *
  * @param {number} rotation Rotation.
  * @api
@@ -185,8 +186,8 @@ ol.style.Image.prototype.setRotation = function(rotation) {
 
 
 /**
- * Set the scale. Use `setStyle()` on the feature, layer or feature overlay
+ * Set the scale. Call `setStyle()` or `dispatchChangeEvent()` on feature, layer
- * for changes to take effect.
+ * or feature overlay for changes to take effect.
  *
  * @param {number} scale Scale.
  * @api
@@ -197,8 +198,9 @@ ol.style.Image.prototype.setScale = function(scale) {
 
 
 /**
- * Set whether to snap the image to the closest pixel. Use `setStyle()` on the
+ * Set whether to snap the image to the closest pixel. Call `setStyle()` or
- * feature, layer or feature overlay for changes to take effect.
+ * `dispatchChangeEvent()` on feature, layer or feature overlay for changes to
+ * take effect.
  *
  * @param {boolean} snapToPixel Snap to pixel?
  */

src/ol/style/strokestyle.js

@@ -110,8 +110,8 @@ ol.style.Stroke.prototype.getWidth = function() {
 
 
 /**
- * Set the color. Use `setStyle()` on the feature, layer or feature overlay
+ * Set the color. Call `setStyle()` or `dispatchChangeEvent()` on feature, layer
- * for changes to take effect.
+ * or feature overlay for changes to take effect.
  *
  * @param {ol.Color|string} color Color.
  * @api
@@ -122,8 +122,8 @@ ol.style.Stroke.prototype.setColor = function(color) {
 
 
 /**
- * Set the line cap. Use `setStyle()` on the feature, layer or feature overlay
+ * Set the line cap. Call `setStyle()` or `dispatchChangeEvent()` on feature,
- * for changes to take effect.
+ * layer or feature overlay for changes to take effect.
  *
  * @param {string|undefined} lineCap Line cap.
  * @api
@@ -134,8 +134,8 @@ ol.style.Stroke.prototype.setLineCap = function(lineCap) {
 
 
 /**
- * Set the line dash. Use `setStyle()` on the feature, layer or feature overlay
+ * Set the line dash. Call `setStyle()` or `dispatchChangeEvent()` on feature,
- * for changes to take effect.
+ * layer or feature overlay for changes to take effect.
  *
  * @param {Array.<number>} lineDash Line dash.
  * @api
@@ -146,8 +146,8 @@ ol.style.Stroke.prototype.setLineDash = function(lineDash) {
 
 
 /**
- * Set the line join. Use `setStyle()` on the feature, layer or feature overlay
+ * Set the line join. Call `setStyle()` or `dispatchChangeEvent()` on feature,
- * for changes to take effect.
+ * layer or feature overlay for changes to take effect.
  *
  * @param {string|undefined} lineJoin Line join.
  * @api
@@ -158,8 +158,8 @@ ol.style.Stroke.prototype.setLineJoin = function(lineJoin) {
 
 
 /**
- * Set the miter limit. Use `setStyle()` on the feature, layer or feature
+ * Set the miter limit. Call `setStyle()` or `dispatchChangeEvent()` on feature,
- * overlay for changes to take effect.
+ * layer or feature overlay for changes to take effect.
  *
  * @param {number|undefined} miterLimit Miter limit.
  * @api
@@ -170,8 +170,8 @@ ol.style.Stroke.prototype.setMiterLimit = function(miterLimit) {
 
 
 /**
- * Set the width. Use `setStyle()` on the feature, layer or feature overlay
+ * Set the width. Call `setStyle()` or `dispatchChangeEvent()` on feature, layer
- * for changes to take effect.
+ * or feature overlay for changes to take effect.
  *
  * @param {number|undefined} width Width.
  * @api

src/ol/style/style.js

@@ -101,8 +101,8 @@ ol.style.Style.prototype.getZIndex = function() {
 
 
 /**
- * Set the zIndex. Use `setStyle()` on the feature, layer or feature overlay
+ * Set the zIndex. Call `setStyle()` or `dispatchChangeEvent()` on feature,
- * for changes to take effect.
+ * layer or feature overlay for changes to take effect.
  *
  * @param {number|undefined} zIndex ZIndex.
  * @api

src/ol/style/textstyle.js

@@ -165,8 +165,8 @@ ol.style.Text.prototype.getTextBaseline = function() {
 
 
 /**
- * Set the font. Use `setStyle()` on the feature, layer or feature overlay
+ * Set the font. Call `setStyle()` or `dispatchChangeEvent()` on feature, layer
- * for changes to take effect.
+ * or feature overlay for changes to take effect.
  *
  * @param {string|undefined} font Font.
  * @api
@@ -177,8 +177,8 @@ ol.style.Text.prototype.setFont = function(font) {
 
 
 /**
- * Set the x offset. Use `setStyle()` on the feature, layer or feature overlay
+ * Set the x offset. Call `setStyle()` or `dispatchChangeEvent()` on feature,
- * for changes to take effect.
+ * layer or feature overlay for changes to take effect.
  *
  * @param {number} offsetX Horizontal text offset.
  */
@@ -188,8 +188,8 @@ ol.style.Text.prototype.setOffsetX = function(offsetX) {
 
 
 /**
- * Set the y offset. Use `setStyle()` on the feature, layer or feature overlay
+ * Set the y offset. Call `setStyle()` or `dispatchChangeEvent()` on feature,
- * for changes to take effect.
+ * layer or feature overlay for changes to take effect.
  *
  * @param {number} offsetY Vertical text offset.
  */
@@ -199,8 +199,8 @@ ol.style.Text.prototype.setOffsetY = function(offsetY) {
 
 
 /**
- * Set the fill. Use `setStyle()` on the feature, layer or feature overlay
+ * Set the fill. Call `setStyle()` or `dispatchChangeEvent()` on feature, layer
- * for changes to take effect.
+ * or feature overlay for changes to take effect.
  *
  * @param {ol.style.Fill} fill Fill style.
  * @api
@@ -211,8 +211,8 @@ ol.style.Text.prototype.setFill = function(fill) {
 
 
 /**
- * Set the rotation. Use `setStyle()` on the feature, layer or feature overlay
+ * Set the rotation. Call `setStyle()` or `dispatchChangeEvent()` on feature,
- * for changes to take effect.
+ * layer or feature overlay for changes to take effect.
  *
  * @param {number|undefined} rotation Rotation.
  * @api
@@ -223,8 +223,8 @@ ol.style.Text.prototype.setRotation = function(rotation) {
 
 
 /**
- * Set the scale. Use `setStyle()` on the feature, layer or feature overlay
+ * Set the scale. Call `setStyle()` or `dispatchChangeEvent()` on feature, layer
- * for changes to take effect.
+ * or feature overlay for changes to take effect.
  *
  * @param {number|undefined} scale Scale.
  * @api
@@ -235,8 +235,8 @@ ol.style.Text.prototype.setScale = function(scale) {
 
 
 /**
- * Set the stroke. Use `setStyle()` on the feature, layer or feature overlay
+ * Set the stroke. Call `setStyle()` or `dispatchChangeEvent()` on feature,
- * for changes to take effect.
+ * layer or feature overlay for changes to take effect.
  *
  * @param {ol.style.Stroke} stroke Stroke style.
  * @api
@@ -247,8 +247,8 @@ ol.style.Text.prototype.setStroke = function(stroke) {
 
 
 /**
- * Set the text. Use `setStyle()` on the feature, layer or feature overlay
+ * Set the text. Call `setStyle()` or `dispatchChangeEvent()` on feature, layer
- * for changes to take effect.
+ * or feature overlay for changes to take effect.
  *
  * @param {string|undefined} text Text.
  * @api
@@ -259,8 +259,8 @@ ol.style.Text.prototype.setText = function(text) {
 
 
 /**
- * Set the text alignment. Use `setStyle()` on the feature, layer or feature
+ * Set the text alignment. Call `setStyle()` or `dispatchChangeEvent()` on
- * overlay for changes to take effect.
+ * feature, layer or feature overlay for changes to take effect.
  *
  * @param {string|undefined} textAlign Text align.
  * @api
@@ -271,8 +271,8 @@ ol.style.Text.prototype.setTextAlign = function(textAlign) {
 
 
 /**
- * Set the text baseline. Use `setStyle()` on the feature, layer or feature
+ * Set the text baseline. Call `setStyle()` or `dispatchChangeEvent()` on
- * overlay for changes to take effect.
+ * feature, layer or feature overlay for changes to take effect.
  *
  * @param {string|undefined} textBaseline Text baseline.
  * @api