Merge pull request #997 from fredj/apidoc

More api doc content

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.
+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.

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}

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:
  *

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}

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}

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}

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}

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}

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}
  */

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}
  */

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}
  */

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}
  */

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}
  */

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}

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}
  */

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}