Style docs

src/ol/style/circlestyle.js

@@ -124,6 +124,7 @@ ol.style.Circle.prototype.getAnchor = function() {
 
 
 /**
+ * Get the fill style for the circle.
  * @return {ol.style.Fill} Fill style.
  * @api
  */
@@ -141,6 +142,7 @@ ol.style.Circle.prototype.getHitDetectionImage = function(pixelRatio) {
 
 
 /**
+ * Get the image used to render the circle.
  * @param {number} pixelRatio Pixel ratio.
  * @return {HTMLCanvasElement} Canvas element.
  * @api
@@ -184,6 +186,7 @@ ol.style.Circle.prototype.getOrigin = function() {
 
 
 /**
+ * Get the circle radius.
  * @return {number} Radius.
  * @api
  */
@@ -202,6 +205,7 @@ ol.style.Circle.prototype.getSize = function() {
 
 
 /**
+ * Get the stroke style for the circle.
  * @return {ol.style.Stroke} Stroke style.
  * @api
  */

src/ol/style/fillstyle.js

@@ -33,6 +33,7 @@ ol.style.Fill = function(opt_options) {
 
 
 /**
+ * Get the fill color.
  * @return {ol.Color|string} Color.
  * @api
  */

src/ol/style/iconstyle.js

@@ -243,6 +243,7 @@ ol.style.Icon.prototype.getAnchor = function() {
 
 
 /**
+ * Get the image icon.
  * @param {number} pixelRatio Pixel ratio.
  * @return {Image} Image element.
  * @api
@@ -317,6 +318,7 @@ ol.style.Icon.prototype.getOrigin = function() {
 
 
 /**
+ * Get the image URL.
  * @return {string|undefined} Image src.
  * @api
  */

src/ol/style/imagestyle.js

@@ -26,7 +26,7 @@ ol.style.ImageOptions;
 
 /**
  * @classdesc
- * Abstract base class; used for creating subclasses and not instantiated in
+ * A base class used for creating subclasses and not instantiated in
  * apps. Base class for {@link ol.style.Icon} and {@link ol.style.Circle}.
  *
  * @constructor
@@ -69,6 +69,7 @@ ol.style.Image = function(options) {
 
 
 /**
+ * Get the symbolizer opacity.
  * @return {number} Opacity.
  * @api
  */
@@ -78,6 +79,7 @@ ol.style.Image.prototype.getOpacity = function() {
 
 
 /**
+ * Determine whether the symbolizer rotates with the map.
  * @return {boolean} Rotate with map.
  * @api
  */
@@ -87,6 +89,7 @@ ol.style.Image.prototype.getRotateWithView = function() {
 
 
 /**
+ * Get the symoblizer rotation.
  * @return {number} Rotation.
  * @api
  */
@@ -96,6 +99,7 @@ ol.style.Image.prototype.getRotation = function() {
 
 
 /**
+ * Get the symbolizer scale.
  * @return {number} Scale.
  * @api
  */
@@ -105,7 +109,8 @@ ol.style.Image.prototype.getScale = function() {
 
 
 /**
- * @return {boolean} Snap to pixel?
+ * Determine whether the symbolizer should be snapped to a pixel.
+ * @return {boolean} The symbolizer should snap to a pixel.
  * @api
  */
 ol.style.Image.prototype.getSnapToPixel = function() {

src/ol/style/regularshapestyle.js

@@ -149,6 +149,7 @@ ol.style.RegularShape.prototype.getAnchor = function() {
 
 
 /**
+ * Get the angle used in generating the shape.
  * @return {number} Shape's rotation in radians.
  * @api
  */
@@ -158,6 +159,7 @@ ol.style.RegularShape.prototype.getAngle = function() {
 
 
 /**
+ * Get the fill style for the shape.
  * @return {ol.style.Fill} Fill style.
  * @api
  */
@@ -217,6 +219,7 @@ ol.style.RegularShape.prototype.getOrigin = function() {
 
 
 /**
+ * Get the number of points for generating the shape.
  * @return {number} Number of points for stars and regular polygons.
  * @api
  */
@@ -226,6 +229,7 @@ ol.style.RegularShape.prototype.getPoints = function() {
 
 
 /**
+ * Get the (primary) radius for the shape.
  * @return {number} Radius.
  * @api
  */
@@ -235,6 +239,7 @@ ol.style.RegularShape.prototype.getRadius = function() {
 
 
 /**
+ * Get the secondary radius for the shape.
  * @return {number} Radius2.
  * @api
  */
@@ -253,6 +258,7 @@ ol.style.RegularShape.prototype.getSize = function() {
 
 
 /**
+ * Get the stroke style for the shape.
  * @return {ol.style.Stroke} Stroke style.
  * @api
  */

src/ol/style/strokestyle.js

@@ -68,6 +68,7 @@ ol.style.Stroke = function(opt_options) {
 
 
 /**
+ * Get the stroke color.
  * @return {ol.Color|string} Color.
  * @api
  */
@@ -77,6 +78,7 @@ ol.style.Stroke.prototype.getColor = function() {
 
 
 /**
+ * Get the line cap type for the stroke.
  * @return {string|undefined} Line cap.
  * @api
  */
@@ -86,6 +88,7 @@ ol.style.Stroke.prototype.getLineCap = function() {
 
 
 /**
+ * Get the line dash style for the stroke.
  * @return {Array.<number>} Line dash.
  * @api
  */
@@ -95,6 +98,7 @@ ol.style.Stroke.prototype.getLineDash = function() {
 
 
 /**
+ * Get the line join type for the stroke.
  * @return {string|undefined} Line join.
  * @api
  */
@@ -104,6 +108,7 @@ ol.style.Stroke.prototype.getLineJoin = function() {
 
 
 /**
+ * Get the miter limit for the stroke.
  * @return {number|undefined} Miter limit.
  * @api
  */
@@ -113,6 +118,7 @@ ol.style.Stroke.prototype.getMiterLimit = function() {
 
 
 /**
+ * Get the stroke width.
  * @return {number|undefined} Width.
  * @api
  */

src/ol/style/style.js

@@ -76,6 +76,7 @@ ol.style.Style = function(opt_options) {
 
 
 /**
+ * Get the geometry to be rendered.
  * @return {string|ol.geom.Geometry|ol.style.GeometryFunction}
  * Feature property or geometry or function that returns the geometry that will
  * be rendered with this style.
@@ -87,6 +88,7 @@ ol.style.Style.prototype.getGeometry = function() {
 
 
 /**
+ * Get the function used to generate a geometry for rendering.
  * @return {!ol.style.GeometryFunction} Function that is called with a feature
  * and returns the geometry to render instead of the feature's geometry.
  * @api
@@ -97,6 +99,7 @@ ol.style.Style.prototype.getGeometryFunction = function() {
 
 
 /**
+ * Get the fill style.
  * @return {ol.style.Fill} Fill style.
  * @api
  */
@@ -106,6 +109,7 @@ ol.style.Style.prototype.getFill = function() {
 
 
 /**
+ * Get the image style.
  * @return {ol.style.Image} Image style.
  * @api
  */
@@ -115,6 +119,7 @@ ol.style.Style.prototype.getImage = function() {
 
 
 /**
+ * Get the stroke style.
  * @return {ol.style.Stroke} Stroke style.
  * @api
  */
@@ -124,6 +129,7 @@ ol.style.Style.prototype.getStroke = function() {
 
 
 /**
+ * Get the text style.
  * @return {ol.style.Text} Text style.
  * @api
  */
@@ -133,6 +139,7 @@ ol.style.Style.prototype.getText = function() {
 
 
 /**
+ * Get the z-index for the style.
  * @return {number|undefined} ZIndex.
  * @api
  */
@@ -175,7 +182,7 @@ ol.style.Style.prototype.setGeometry = function(geometry) {
 
 
 /**
- * Set the zIndex.
+ * Set the z-index.
  *
  * @param {number|undefined} zIndex ZIndex.
  * @api

src/ol/style/textstyle.js

@@ -77,6 +77,7 @@ ol.style.Text = function(opt_options) {
 
 
 /**
+ * Get the font name.
  * @return {string|undefined} Font.
  * @api
  */
@@ -86,6 +87,7 @@ ol.style.Text.prototype.getFont = function() {
 
 
 /**
+ * Get the x-offset for the text.
  * @return {number} Horizontal text offset.
  * @api
  */
@@ -95,6 +97,7 @@ ol.style.Text.prototype.getOffsetX = function() {
 
 
 /**
+ * Get the y-offset for the text.
  * @return {number} Vertical text offset.
  * @api
  */
@@ -104,6 +107,7 @@ ol.style.Text.prototype.getOffsetY = function() {
 
 
 /**
+ * Get the fill style for the text.
  * @return {ol.style.Fill} Fill style.
  * @api
  */
@@ -113,6 +117,7 @@ ol.style.Text.prototype.getFill = function() {
 
 
 /**
+ * Get the text rotation.
  * @return {number|undefined} Rotation.
  * @api
  */
@@ -122,6 +127,7 @@ ol.style.Text.prototype.getRotation = function() {
 
 
 /**
+ * Get the text scale.
  * @return {number|undefined} Scale.
  * @api
  */
@@ -131,6 +137,7 @@ ol.style.Text.prototype.getScale = function() {
 
 
 /**
+ * Get the stroke style for the text.
  * @return {ol.style.Stroke} Stroke style.
  * @api
  */
@@ -140,6 +147,7 @@ ol.style.Text.prototype.getStroke = function() {
 
 
 /**
+ * Get the text to be rendered.
  * @return {string|undefined} Text.
  * @api
  */
@@ -149,6 +157,7 @@ ol.style.Text.prototype.getText = function() {
 
 
 /**
+ * Get the text alignment.
  * @return {string|undefined} Text align.
  * @api
  */
@@ -158,6 +167,7 @@ ol.style.Text.prototype.getTextAlign = function() {
 
 
 /**
+ * Get the text baseline.
  * @return {string|undefined} Text baseline.
  * @api
  */