From 8c08c684b2ddbf4f457467c3656e50dbe32f721c Mon Sep 17 00:00:00 2001 From: Adrien Berthet Date: Fri, 14 Dec 2018 10:43:22 +0100 Subject: [PATCH] docs: cleaning and updating the Source/ folder Part of #968 --- src/Source/FileSource.js | 3 ++- src/Source/Source.js | 4 ++-- src/Source/TMSSource.js | 8 ++++---- src/Source/WFSSource.js | 2 +- src/Source/WMSSource.js | 6 +++--- src/Source/WMTSSource.js | 6 +++++- 6 files changed, 17 insertions(+), 12 deletions(-) diff --git a/src/Source/FileSource.js b/src/Source/FileSource.js index 148ae8b8b8..257273e53a 100644 --- a/src/Source/FileSource.js +++ b/src/Source/FileSource.js @@ -107,7 +107,8 @@ function fileParser(text) { class FileSource extends Source { /** * @param {Object} source - An object that can contain all properties of a - * FileSource. Only url and projection are mandatory. + * FileSource and {@link Source}. Only url and + * projection are mandatory. * @param {string} crsOut - The projection of the output data after parsing. * * @constructor diff --git a/src/Source/Source.js b/src/Source/Source.js index 4f42783dd7..831728947d 100644 --- a/src/Source/Source.js +++ b/src/Source/Source.js @@ -5,8 +5,8 @@ import Extent from 'Core/Geographic/Extent'; * Sources are object containing informations on how to fetch resources, from a * set source. * - * To extend a Source, it is necessary to implement two functions: {@link - * Source#urlFromExtent} and {@link Source#extentInsideLimit}. + * To extend a Source, it is necessary to implement two functions: + * urlFromExtent and extentInsideLimit. * * @property {boolean} isSource - Used to checkout whether this source is a * Source. Default is true. You should not change this, as it is used internally diff --git a/src/Source/TMSSource.js b/src/Source/TMSSource.js index 83ab20e2ed..07f9ff5e06 100644 --- a/src/Source/TMSSource.js +++ b/src/Source/TMSSource.js @@ -16,9 +16,9 @@ import Extent from 'Core/Geographic/Extent'; * @property {boolean} isInverted - The isInverted property is to be set to the * correct value, true or false (default being false) if the computation of the * coordinates needs to be inverted to match the same scheme as OSM, Google Maps - * or other system. See {@link - * https://alastaira.wordpress.com/2011/07/06/converting-tms-tile-coordinates-to-googlebingosm-tile-coordinates/|this - * link} for more information. + * or other system. See [this link]{@link + * https://alastaira.wordpress.com/2011/07/06/converting-tms-tile-coordinates-to-googlebingosm-tile-coordinates/} + * for more information. * @property {string} tileMatrixSet - Tile matrix set of the layer, used in the * generation of the coordinates to build the url. Default value is 'WGS84'. * @property {Object} zoom - Object containing the minimum and maximum values of @@ -51,7 +51,7 @@ import Extent from 'Core/Geographic/Extent'; class TMSSource extends Source { /** * @param {Object} source - An object that can contain all properties of a - * TMSSource. Only url is mandatory. + * TMSSource and {@link Source}. Only url is mandatory. * * @constructor */ diff --git a/src/Source/WFSSource.js b/src/Source/WFSSource.js index e1855ef319..a1d01c6ef2 100644 --- a/src/Source/WFSSource.js +++ b/src/Source/WFSSource.js @@ -85,7 +85,7 @@ import URLBuilder from 'Provider/URLBuilder'; class WFSSource extends Source { /** * @param {Object} source - An object that can contain all properties of a - * WFSSource. url, typeName and + * WFSSource and {@link Source}. url, typeName and * projection are mandatory. * * @constructor diff --git a/src/Source/WMSSource.js b/src/Source/WMSSource.js index c713fa0829..d39f038fef 100644 --- a/src/Source/WMSSource.js +++ b/src/Source/WMSSource.js @@ -59,9 +59,9 @@ import URLBuilder from 'Provider/URLBuilder'; */ class WMSSource extends Source { /** - * @param {Object} source - An object that can contain all properties of a - * WMSSource. url, name, extent and - * projection are mandatory. + * @param {Object} source - An object that can contain all properties of + * WMSSource and {@link Source}. url, name, + * extent and projection are mandatory. * * @constructor */ diff --git a/src/Source/WMTSSource.js b/src/Source/WMTSSource.js index 93605cd388..863b53e262 100644 --- a/src/Source/WMTSSource.js +++ b/src/Source/WMTSSource.js @@ -18,6 +18,9 @@ import URLBuilder from 'Provider/URLBuilder'; * Default value is '1.0.0'. * @property {string} style - The style to query on the WMTS server. Default * value is 'normal'. + * @property {string} projection - The projection in which to fetch the data. If + * not specified, it is deduced from tileMatrixSet. Default value + * is 'EPSG:3857'. * @property {string} tileMatrixSet - Tile matrix set of the layer, used in the * generation of the url. Default value is 'WGS84'. * @property {Object} tileMatrixSetLimits - Limits of the tile matrix @@ -59,7 +62,8 @@ import URLBuilder from 'Provider/URLBuilder'; class WMTSSource extends Source { /** * @param {Object} source - An object that can contain all properties of a - * WMTSSource. Only url and name are mandatory. + * WMTSSource and {@link Source}. Only url and + * name are mandatory. * * @constructor */