Add more api doc

This commit is contained in:
Frederic Junod
2013-09-08 16:51:32 +02:00
parent cf7b40268b
commit 20916c75bb
15 changed files with 39 additions and 1 deletions

View File

@@ -16,6 +16,9 @@ goog.require('ol.css');
/** /**
* Provides a button that when clicked fills up the full screen with the map. * 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. * 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 * @constructor
* @extends {ol.control.Control} * @extends {ol.control.Control}

View File

@@ -32,7 +32,8 @@ ol.GeolocationProperty = {
/** /**
* Helper class for providing HTML5 Geolocation capabilities. * 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: * Example:
* *

View File

@@ -21,6 +21,8 @@ goog.require('ol.parser.StringFeatureParser');
/** /**
* Read and write [GeoJSON](http://geojson.org/)
*
* @constructor * @constructor
* @implements {ol.parser.StringFeatureParser} * @implements {ol.parser.StringFeatureParser}
* @extends {ol.parser.Parser} * @extends {ol.parser.Parser}

View File

@@ -16,6 +16,8 @@ goog.require('ol.parser.XML');
/** /**
* Read and write [GPX](http://www.topografix.com/gpx.asp) version 1.1
*
* @constructor * @constructor
* @implements {ol.parser.DomFeatureParser} * @implements {ol.parser.DomFeatureParser}
* @implements {ol.parser.StringFeatureParser} * @implements {ol.parser.StringFeatureParser}

View File

@@ -34,6 +34,9 @@ goog.require('ol.style.Stroke');
/** /**
* Read and write [KML](http://www.opengeospatial.org/standards/kml)
* version 2.2
*
* @constructor * @constructor
* @implements {ol.parser.DomFeatureParser} * @implements {ol.parser.DomFeatureParser}
* @implements {ol.parser.StringFeatureParser} * @implements {ol.parser.StringFeatureParser}

View File

@@ -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 * @constructor
* @param {ol.parser.GMLOptions=} opt_options Optional configuration object. * @param {ol.parser.GMLOptions=} opt_options Optional configuration object.
* @extends {ol.parser.ogc.GML} * @extends {ol.parser.ogc.GML}

View File

@@ -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 * @constructor
* @param {ol.parser.GMLOptions=} opt_options Optional configuration object. * @param {ol.parser.GMLOptions=} opt_options Optional configuration object.
* @extends {ol.parser.ogc.GML} * @extends {ol.parser.ogc.GML}

View File

@@ -6,6 +6,8 @@ goog.require('ol.parser.XML');
/** /**
* Read [WMS](http://www.opengeospatial.org/standards/wms) capabilities
*
* @constructor * @constructor
* @extends {ol.parser.XML} * @extends {ol.parser.XML}
*/ */

View File

@@ -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 * @constructor
* @extends {ol.parser.ogc.WMSCapabilities_v1_1_0} * @extends {ol.parser.ogc.WMSCapabilities_v1_1_0}
*/ */

View File

@@ -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 * @constructor
* @extends {ol.parser.ogc.WMSCapabilities_v1_1} * @extends {ol.parser.ogc.WMSCapabilities_v1_1}
*/ */

View File

@@ -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 * @constructor
* @extends {ol.parser.ogc.WMSCapabilities_v1_1} * @extends {ol.parser.ogc.WMSCapabilities_v1_1}
*/ */

View File

@@ -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 * @constructor
* @extends {ol.parser.ogc.WMSCapabilities_v1} * @extends {ol.parser.ogc.WMSCapabilities_v1}
*/ */

View File

@@ -5,6 +5,8 @@ goog.require('ol.parser.ogc.WMTSCapabilities_v1_0_0');
/** /**
* Read [WMTS](http://www.opengeospatial.org/standards/wmts) capabilities
*
* @constructor * @constructor
* @param {Object=} opt_options Options which will be set on this object. * @param {Object=} opt_options Options which will be set on this object.
* @extends {ol.parser.ogc.Versioned} * @extends {ol.parser.ogc.Versioned}

View File

@@ -8,6 +8,9 @@ goog.require('ol.proj');
/** /**
* Read [WMTS](http://www.opengeospatial.org/standards/wmts) capabilities
* version 1.0
*
* @constructor * @constructor
* @extends {ol.parser.XML} * @extends {ol.parser.XML}
*/ */

View File

@@ -17,6 +17,8 @@ goog.require('ol.parser.StringFeatureParser');
/** /**
* Read [TopoJSON](https://github.com/mbostock/topojson)
*
* @constructor * @constructor
* @implements {ol.parser.StringFeatureParser} * @implements {ol.parser.StringFeatureParser}
* @extends {ol.parser.Parser} * @extends {ol.parser.Parser}