Document options default value

This commit is contained in:
Frederic Junod
2014-07-22 15:11:40 +02:00
parent 7b7788973b
commit 8cf48eac4f
+6 -6
View File
@@ -1686,7 +1686,7 @@ olx.interaction.DrawOptions.prototype.source;
/** /**
* Pixel distance for snapping to the drawing finish (default is 12). * Pixel distance for snapping to the drawing finish. Default is `12`.
* @type {number|undefined} * @type {number|undefined}
*/ */
olx.interaction.DrawOptions.prototype.snapTolerance; olx.interaction.DrawOptions.prototype.snapTolerance;
@@ -1701,8 +1701,8 @@ olx.interaction.DrawOptions.prototype.type;
/** /**
* The number of points that must be drawn before a polygon ring can be finished * The number of points that must be drawn before a polygon ring can be finished.
* (default is 3). * Default is `3`.
* @type {number|undefined} * @type {number|undefined}
*/ */
olx.interaction.DrawOptions.prototype.minPointsPerRing; olx.interaction.DrawOptions.prototype.minPointsPerRing;
@@ -1810,7 +1810,7 @@ olx.interaction.ModifyOptions.prototype.deleteCondition;
/** /**
* Pixel tolerance for considering the pointer close enough to a segment or * Pixel tolerance for considering the pointer close enough to a segment or
* vertex for editing. Default is 10 pixels. * vertex for editing. Default is `10` pixels.
* @type {number|undefined} * @type {number|undefined}
*/ */
olx.interaction.ModifyOptions.prototype.pixelTolerance; olx.interaction.ModifyOptions.prototype.pixelTolerance;
@@ -4299,14 +4299,14 @@ olx.source.WMTSOptions.prototype.tilePixelRatio;
/** /**
* WMTS version. Default to `1.0.0`. * WMTS version. Default is `1.0.0`.
* @type {string|undefined} * @type {string|undefined}
*/ */
olx.source.WMTSOptions.prototype.version; olx.source.WMTSOptions.prototype.version;
/** /**
* Format. * Image format. Default is `image/jpeg`.
* @type {string|undefined} * @type {string|undefined}
*/ */
olx.source.WMTSOptions.prototype.format; olx.source.WMTSOptions.prototype.format;