diff --git a/doc/index.md b/doc/index.md index e7fa1d4d02..431d7c0b4e 100644 --- a/doc/index.md +++ b/doc/index.md @@ -6,7 +6,9 @@ In general every use of OpenLayers starts by initializing a map, then adding th Projections ----------- -A {@link ol.Projection} defines which point on earth is represented by a pair of coordinates. Coordinates within OpenLayers can be used in various projections where some common projections are always supported, others can be used via Proj4js. +A {@link ol.Projection} defines which point on earth is represented by a pair of coordinates. +Coordinates within OpenLayers can be used in various projections where some common projections are always supported, +others can be used via [Proj4js](http://trac.osgeo.org/proj4js/). Maps and Layers --------------- @@ -14,4 +16,5 @@ A map in OpenLayers is essentially a staple of layers that is viewed from the to Contributing ------------ -See CONTRIBUTING.md for instructions on building and tesing OpenLayers. The file does also describe how to commit your changes to OpenLayers. \ No newline at end of file +See [CONTRIBUTING.md](https://github.com/openlayers/ol3/blob/master/CONTRIBUTING.md) for instructions +on building and tesing OpenLayers. The file does also describe how to commit your changes to OpenLayers. diff --git a/src/ol/control/fullscreencontrol.js b/src/ol/control/fullscreencontrol.js index 45c2f0b7c8..70c9913d85 100644 --- a/src/ol/control/fullscreencontrol.js +++ b/src/ol/control/fullscreencontrol.js @@ -16,6 +16,9 @@ goog.require('ol.css'); /** * Provides a button that when clicked fills up the full screen with the map. * When in full screen mode, a close button is shown to exit full screen mode. + * The [Fullscreen API](http://www.w3.org/TR/fullscreen/) is used to + * toggle the map in full screen mode. + * * * @constructor * @extends {ol.control.Control} diff --git a/src/ol/geolocation.js b/src/ol/geolocation.js index 0c64c7b20d..ec5f762690 100644 --- a/src/ol/geolocation.js +++ b/src/ol/geolocation.js @@ -32,7 +32,8 @@ ol.GeolocationProperty = { /** * Helper class for providing HTML5 Geolocation capabilities. - * HTML5 Geolocation is used to locate a user's position. + * The [Geolocation API](http://dev.w3.org/geo/api/spec-source.html) + * is used to locate a user's position. * * Example: * diff --git a/src/ol/parser/geojson.js b/src/ol/parser/geojson.js index 2370db2a04..d7c4549f11 100644 --- a/src/ol/parser/geojson.js +++ b/src/ol/parser/geojson.js @@ -21,6 +21,8 @@ goog.require('ol.parser.StringFeatureParser'); /** + * Read and write [GeoJSON](http://geojson.org/) + * * @constructor * @implements {ol.parser.StringFeatureParser} * @extends {ol.parser.Parser} diff --git a/src/ol/parser/gpx.js b/src/ol/parser/gpx.js index d21ee2fba8..a8e0f61057 100644 --- a/src/ol/parser/gpx.js +++ b/src/ol/parser/gpx.js @@ -16,6 +16,8 @@ goog.require('ol.parser.XML'); /** + * Read and write [GPX](http://www.topografix.com/gpx.asp) version 1.1 + * * @constructor * @implements {ol.parser.DomFeatureParser} * @implements {ol.parser.StringFeatureParser} diff --git a/src/ol/parser/kml.js b/src/ol/parser/kml.js index 346100b9b7..b726f9b5fc 100644 --- a/src/ol/parser/kml.js +++ b/src/ol/parser/kml.js @@ -34,6 +34,9 @@ goog.require('ol.style.Stroke'); /** + * Read and write [KML](http://www.opengeospatial.org/standards/kml) + * version 2.2 + * * @constructor * @implements {ol.parser.DomFeatureParser} * @implements {ol.parser.StringFeatureParser} diff --git a/src/ol/parser/ogc/gml_v2.js b/src/ol/parser/ogc/gml_v2.js index b32aa1af11..cdc7799745 100644 --- a/src/ol/parser/ogc/gml_v2.js +++ b/src/ol/parser/ogc/gml_v2.js @@ -7,6 +7,9 @@ goog.require('ol.parser.ogc.GML'); /** + * Read and write [GML](http://www.opengeospatial.org/standards/gml) + * version 2.1.2 + * * @constructor * @param {ol.parser.GMLOptions=} opt_options Optional configuration object. * @extends {ol.parser.ogc.GML} diff --git a/src/ol/parser/ogc/gml_v3.js b/src/ol/parser/ogc/gml_v3.js index a9e5706a2d..aa329335f9 100644 --- a/src/ol/parser/ogc/gml_v3.js +++ b/src/ol/parser/ogc/gml_v3.js @@ -9,6 +9,9 @@ goog.require('ol.parser.ogc.GML'); /** + * Read and write [GML](http://www.opengeospatial.org/standards/gml) + * version 3.1.1 + * * @constructor * @param {ol.parser.GMLOptions=} opt_options Optional configuration object. * @extends {ol.parser.ogc.GML} diff --git a/src/ol/parser/ogc/wmscapabilities_v1.js b/src/ol/parser/ogc/wmscapabilities_v1.js index 018fdf2ab5..55ed0c5a07 100644 --- a/src/ol/parser/ogc/wmscapabilities_v1.js +++ b/src/ol/parser/ogc/wmscapabilities_v1.js @@ -6,6 +6,8 @@ goog.require('ol.parser.XML'); /** + * Read [WMS](http://www.opengeospatial.org/standards/wms) capabilities + * * @constructor * @extends {ol.parser.XML} */ diff --git a/src/ol/parser/ogc/wmscapabilities_v1_0_0.js b/src/ol/parser/ogc/wmscapabilities_v1_0_0.js index 6edebde553..3053a2ad8b 100644 --- a/src/ol/parser/ogc/wmscapabilities_v1_0_0.js +++ b/src/ol/parser/ogc/wmscapabilities_v1_0_0.js @@ -7,6 +7,9 @@ goog.require('ol.parser.ogc.WMSCapabilities_v1_1_0'); /** + * Read [WMS](http://www.opengeospatial.org/standards/wms) capabilities + * version 1.0.0 + * * @constructor * @extends {ol.parser.ogc.WMSCapabilities_v1_1_0} */ diff --git a/src/ol/parser/ogc/wmscapabilities_v1_1_0.js b/src/ol/parser/ogc/wmscapabilities_v1_1_0.js index dbd8d137d1..018d3cb78f 100644 --- a/src/ol/parser/ogc/wmscapabilities_v1_1_0.js +++ b/src/ol/parser/ogc/wmscapabilities_v1_1_0.js @@ -6,6 +6,9 @@ goog.require('ol.parser.ogc.WMSCapabilities_v1_1'); /** + * Read [WMS](http://www.opengeospatial.org/standards/wms) capabilities + * version 1.1.0 + * * @constructor * @extends {ol.parser.ogc.WMSCapabilities_v1_1} */ diff --git a/src/ol/parser/ogc/wmscapabilities_v1_1_1.js b/src/ol/parser/ogc/wmscapabilities_v1_1_1.js index bb569e3241..6dd29470da 100644 --- a/src/ol/parser/ogc/wmscapabilities_v1_1_1.js +++ b/src/ol/parser/ogc/wmscapabilities_v1_1_1.js @@ -6,6 +6,9 @@ goog.require('ol.parser.ogc.WMSCapabilities_v1_1'); /** + * Read [WMS](http://www.opengeospatial.org/standards/wms) capabilities + * version 1.1.1 + * * @constructor * @extends {ol.parser.ogc.WMSCapabilities_v1_1} */ diff --git a/src/ol/parser/ogc/wmscapabilities_v1_3_0.js b/src/ol/parser/ogc/wmscapabilities_v1_3_0.js index b795728153..fc6a79c685 100644 --- a/src/ol/parser/ogc/wmscapabilities_v1_3_0.js +++ b/src/ol/parser/ogc/wmscapabilities_v1_3_0.js @@ -6,6 +6,9 @@ goog.require('ol.parser.ogc.WMSCapabilities_v1'); /** + * Read [WMS](http://www.opengeospatial.org/standards/wms) capabilities + * version 1.3.0 + * * @constructor * @extends {ol.parser.ogc.WMSCapabilities_v1} */ diff --git a/src/ol/parser/ogc/wmtscapabilities.js b/src/ol/parser/ogc/wmtscapabilities.js index fee0293153..37c095e318 100644 --- a/src/ol/parser/ogc/wmtscapabilities.js +++ b/src/ol/parser/ogc/wmtscapabilities.js @@ -5,6 +5,8 @@ goog.require('ol.parser.ogc.WMTSCapabilities_v1_0_0'); /** + * Read [WMTS](http://www.opengeospatial.org/standards/wmts) capabilities + * * @constructor * @param {Object=} opt_options Options which will be set on this object. * @extends {ol.parser.ogc.Versioned} diff --git a/src/ol/parser/ogc/wmtscapabilities_v1_0_0.js b/src/ol/parser/ogc/wmtscapabilities_v1_0_0.js index f6b861f44b..675db608dc 100644 --- a/src/ol/parser/ogc/wmtscapabilities_v1_0_0.js +++ b/src/ol/parser/ogc/wmtscapabilities_v1_0_0.js @@ -8,6 +8,9 @@ goog.require('ol.proj'); /** + * Read [WMTS](http://www.opengeospatial.org/standards/wmts) capabilities + * version 1.0 + * * @constructor * @extends {ol.parser.XML} */ diff --git a/src/ol/parser/topojson.js b/src/ol/parser/topojson.js index b17badf7b1..eba0a69be9 100644 --- a/src/ol/parser/topojson.js +++ b/src/ol/parser/topojson.js @@ -17,6 +17,8 @@ goog.require('ol.parser.StringFeatureParser'); /** + * Read [TopoJSON](https://github.com/mbostock/topojson) + * * @constructor * @implements {ol.parser.StringFeatureParser} * @extends {ol.parser.Parser}