diff --git a/externs/olx.js b/externs/olx.js index 8d94e6f8f6..2faa3bf5e1 100644 --- a/externs/olx.js +++ b/externs/olx.js @@ -4652,8 +4652,8 @@ olx.style.FillOptions; /** - * Color. Default null; if null, the Canvas/renderer default black will be - * used. + * Color. See {@link ol.color} for possible formats. Default null; if null, + * the Canvas/renderer default black will be used. * @type {ol.Color|string|undefined} */ olx.style.FillOptions.prototype.color; @@ -4805,8 +4805,8 @@ olx.style.StrokeOptions; /** - * Color. Default null; if null, the Canvas/renderer default black will be - * used. + * Color. See {@link ol.color} for possible formats. Default null; if null, + * the Canvas/renderer default black will be used. * @type {ol.Color|string|undefined} */ olx.style.StrokeOptions.prototype.color; diff --git a/src/ol/color/color.js b/src/ol/color/color.js index 98441ead15..2a4e460c0f 100644 --- a/src/ol/color/color.js +++ b/src/ol/color/color.js @@ -110,7 +110,7 @@ ol.color.asArray = function(color) { /** * @param {ol.Color|string} color Color. - * @return {string} String. + * @return {string} Rgba string. * @api */ ol.color.asString = function(color) { diff --git a/src/ol/color/color.jsdoc b/src/ol/color/color.jsdoc index fb6dced915..569033933c 100644 --- a/src/ol/color/color.jsdoc +++ b/src/ol/color/color.jsdoc @@ -1,3 +1,8 @@ /** + * Colors can be defined as a {@link ol.Color} array, or as strings in + * `rgb(r,g,b)` or `rgba(r,g,b,a)` format, or in hex `#rrggbb` or `#rgb` format. + * Color names, like 'red', 'blue' or 'green', may also be used with the + * Canvas renderer. + * * @namespace ol.color */ diff --git a/src/ol/ol.js b/src/ol/ol.js index 465d2c3687..de2a929f3c 100644 --- a/src/ol/ol.js +++ b/src/ol/ol.js @@ -104,9 +104,11 @@ ol.ENABLE_IMAGE = true; /** - * @define {boolean} Enable named colors. Enabling named colors adds about 3KB - * uncompressed / 1.5KB compressed to the final build size. Default is - * `false`. + * @define {boolean} Enable Closure named colors (`goog.color.names`). + * Enabling these colors adds about 3KB uncompressed / 1.5KB compressed to + * the final build size. Default is `false`. This setting has no effect + * with Canvas renderer, which uses its own names, whether this is true or + * false. */ ol.ENABLE_NAMED_COLORS = false;