Skip to content

Commit

Permalink
docs: cleaning and updating the Source/ folder
Browse files Browse the repository at this point in the history
Part of #968
  • Loading branch information
zarov committed Dec 14, 2018
1 parent c954f1d commit caf22c2
Show file tree
Hide file tree
Showing 6 changed files with 17 additions and 12 deletions.
3 changes: 2 additions & 1 deletion src/Source/FileSource.js
Original file line number Diff line number Diff line change
Expand Up @@ -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 <code>url</code> and <code>projection</code> are mandatory.
* FileSource and {@link Source}. Only <code>url</code> and
* <code>projection</code> are mandatory.
* @param {string} crsOut - The projection of the output data after parsing.
*
* @constructor
Expand Down
4 changes: 2 additions & 2 deletions src/Source/Source.js
Original file line number Diff line number Diff line change
Expand Up @@ -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:
* <code>urlFromExtent</code> and <code>extentInsideLimit</code>.
*
* @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
Expand Down
8 changes: 4 additions & 4 deletions src/Source/TMSSource.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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 <code>url</code> is mandatory.
* TMSSource and {@link Source}. Only <code>url</code> is mandatory.
*
* @constructor
*/
Expand Down
2 changes: 1 addition & 1 deletion src/Source/WFSSource.js
Original file line number Diff line number Diff line change
Expand Up @@ -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. <code>url</code>, <code>typeName</code> and
* WFSSource and {@link Source}. <code>url</code>, <code>typeName</code> and
* <code>projection</code> are mandatory.
*
* @constructor
Expand Down
6 changes: 3 additions & 3 deletions src/Source/WMSSource.js
Original file line number Diff line number Diff line change
Expand Up @@ -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. <code>url</code>, <code>name</code>, <code>extent</code> and
* <code>projection</code> are mandatory.
* @param {Object} source - An object that can contain all properties of
* WMSSource and {@link Source}. <code>url</code>, <code>name</code>,
* <code>extent</code> and <code>projection</code> are mandatory.
*
* @constructor
*/
Expand Down
6 changes: 5 additions & 1 deletion src/Source/WMTSSource.js
Original file line number Diff line number Diff line change
Expand Up @@ -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 <code>tileMatrixSet</code>. 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
Expand Down Expand Up @@ -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 <code>url</code> and <code>name</code> are mandatory.
* WMTSSource and {@link Source}. Only <code>url</code> and
* <code>name</code> are mandatory.
*
* @constructor
*/
Expand Down

0 comments on commit caf22c2

Please sign in to comment.