Document boolean defines as positive assertions

This commit is contained in:
Tim Schaub
2014-05-04 15:13:21 -07:00
parent 070f81aa7d
commit d069f955f8

View File

@@ -64,60 +64,62 @@ ol.DRAG_BOX_HYSTERESIS_PIXELS = 8;
/**
* @define {boolean} Whether to enable canvas. Default is `true`.
* @define {boolean} Enable the Canvas renderer. Default is `true`.
*/
ol.ENABLE_CANVAS = true;
/**
* @define {boolean} Whether to enable DOM. Default is `true`.
* @define {boolean} Enable the DOM renderer (used as a fallback where Canvas is
* not available). Default is `true`.
*/
ol.ENABLE_DOM = true;
/**
* @define {boolean} Whether to enable rendering of image layers. Default is
* `true`.
* @define {boolean} Enable rendering of ol.layer.Image based layers. Default
* is `true`.
*/
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 `true`.
* @define {boolean} Enable named colors. Enabling named colors adds about 3KB
* uncompressed / 1.5KB compressed to the final build size. Default is
* `true`.
*/
ol.ENABLE_NAMED_COLORS = true;
/**
* @define {boolean} Enable Proj4js. Default is `true`.
* @define {boolean} Enable integration with the Proj4js library. Default is
* `true`.
*/
ol.ENABLE_PROJ4JS = true;
/**
* @define {boolean} Whether to enable rendering of tile layers. Default is
* @define {boolean} Enable rendering of ol.layer.Tile based layers. Default is
* `true`.
*/
ol.ENABLE_TILE = true;
/**
* @define {boolean} Whether to enable rendering of vector layers. Default is
* `true`.
* @define {boolean} Enable rendering of ol.layer.Vector based layers. Default
* is `true`.
*/
ol.ENABLE_VECTOR = true;
/**
* @define {boolean} Whether to enable WebGL. Default is `true`.
* @define {boolean} Enable the WebGL renderer. Default is `true`.
*/
ol.ENABLE_WEBGL = true;
/**
* @define {boolean} Whether to support legacy IE (7-8). Default is `false`.
* @define {boolean} Support legacy IE (7-8). Default is `false`.
*/
ol.LEGACY_IE_SUPPORT = false;