Merge pull request #4502 from fredj/optionsFromCapabilities_jsdoc

Improve ol.source.WMTS.optionsFromCapabilities jsdoc layout
This commit is contained in:
Frédéric Junod
2015-12-04 13:44:27 +01:00

View File

@@ -305,19 +305,19 @@ ol.source.WMTS.prototype.updateDimensions = function(dimensions) {
* the layer will apply if not provided.
*
* Required config properties:
* layer - {String} The layer identifier.
* - layer - {string} The layer identifier.
*
* Optional config properties:
* matrixSet - {String} The matrix set identifier, required if there is
* more than one matrix set in the layer capabilities.
* projection - {String} The desired CRS when no matrixSet is specified.
* eg: "EPSG:3857". If the desired projection is not available,
* an error is thrown.
* requestEncoding - {String} url encoding format for the layer. Default is the
* first tile url format found in the GetCapabilities response.
* style - {String} The name of the style
* format - {String} Image format for the layer. Default is the first
* format returned in the GetCapabilities response.
* - matrixSet - {string} The matrix set identifier, required if there is
* more than one matrix set in the layer capabilities.
* - projection - {string} The desired CRS when no matrixSet is specified.
* eg: "EPSG:3857". If the desired projection is not available,
* an error is thrown.
* - requestEncoding - {string} url encoding format for the layer. Default is
* the first tile url format found in the GetCapabilities response.
* - style - {string} The name of the style
* - format - {string} Image format for the layer. Default is the first
* format returned in the GetCapabilities response.
* @return {olx.source.WMTSOptions} WMTS source options object.
* @api
*/