Add default stability level to docs of exported things.

This commit is contained in:
Paul Spencer
2013-10-24 17:07:02 -04:00
parent a13c5d30a2
commit bada596b45
108 changed files with 382 additions and 0 deletions

View File

@@ -24,6 +24,7 @@ goog.require('ol.parser.StringFeatureParser');
* @constructor
* @implements {ol.parser.StringFeatureParser}
* @extends {ol.parser.Parser}
* @todo stability experimental
*/
ol.parser.GeoJSON = function() {};
goog.inherits(ol.parser.GeoJSON, ol.parser.Parser);

View File

@@ -23,6 +23,7 @@ goog.require('ol.parser.XML');
* @implements {ol.parser.ObjectFeatureParser}
* @param {ol.parser.GPXOptions=} opt_options Optional configuration object.
* @extends {ol.parser.XML}
* @todo stability experimental
*/
ol.parser.GPX = function(opt_options) {
var options = /** @type {ol.parser.GPXOptions} */

View File

@@ -42,6 +42,7 @@ goog.require('ol.style.Stroke');
* @implements {ol.parser.AsyncStringFeatureParser}
* @param {ol.parser.KMLOptions=} opt_options Optional configuration object.
* @extends {ol.parser.XML}
* @todo stability experimental
*/
ol.parser.KML = function(opt_options) {
var options = /** @type {ol.parser.KMLOptions} */

View File

@@ -13,6 +13,7 @@ goog.require('ol.parser.ogc.GML');
* @constructor
* @param {ol.parser.GMLOptions=} opt_options Optional configuration object.
* @extends {ol.parser.ogc.GML}
* @todo stability experimental
*/
ol.parser.ogc.GML_v2 = function(opt_options) {
this.schemaLocation = 'http://www.opengis.net/gml ' +
@@ -127,6 +128,7 @@ goog.inherits(ol.parser.ogc.GML_v2, ol.parser.ogc.GML);
* GML.
* @param {ol.parser.GMLWriteOptions=} opt_options Write options.
* @return {string} A string representing the GML document.
* @todo stability experimental
*/
ol.parser.ogc.GML_v2.prototype.write = function(obj, opt_options) {
this.applyWriteOptions(obj, opt_options);

View File

@@ -15,6 +15,7 @@ goog.require('ol.parser.ogc.GML');
* @constructor
* @param {ol.parser.GMLOptions=} opt_options Optional configuration object.
* @extends {ol.parser.ogc.GML}
* @todo stability experimental
*/
ol.parser.ogc.GML_v3 = function(opt_options) {
this.schemaLocation = 'http://www.opengis.net/gml ' +
@@ -425,6 +426,7 @@ goog.inherits(ol.parser.ogc.GML_v3, ol.parser.ogc.GML);
* XML.
* @param {ol.parser.GMLWriteOptions=} opt_options Write options.
* @return {string} An string representing the XML document.
* @todo stability experimental
*/
ol.parser.ogc.GML_v3.prototype.write = function(obj, opt_options) {
this.applyWriteOptions(obj, opt_options);

View File

@@ -43,6 +43,7 @@ ol.ENABLE_WMSCAPS_1_1_1_WMSC = true;
* @constructor
* @param {Object=} opt_options Options which will be set on this object.
* @extends {ol.parser.ogc.Versioned}
* @todo stability experimental
*/
ol.parser.ogc.WMSCapabilities = function(opt_options) {
opt_options = opt_options || {};

View File

@@ -10,6 +10,7 @@ goog.require('ol.parser.ogc.WMTSCapabilities_v1_0_0');
* @constructor
* @param {Object=} opt_options Options which will be set on this object.
* @extends {ol.parser.ogc.Versioned}
* @todo stability experimental
*/
ol.parser.ogc.WMTSCapabilities = function(opt_options) {
opt_options = opt_options || {};

View File

@@ -4,5 +4,6 @@ goog.provide('ol.parser.Parser');
/**
* @constructor
* @todo stability experimental
*/
ol.parser.Parser = function() {};

View File

@@ -20,6 +20,7 @@ goog.require('ol.parser.StringFeatureParser');
* @constructor
* @implements {ol.parser.StringFeatureParser}
* @extends {ol.parser.Parser}
* @todo stability experimental
*/
ol.parser.TopoJSON = function() {};
goog.inherits(ol.parser.TopoJSON, ol.parser.Parser);

View File

@@ -17,6 +17,7 @@ goog.require('ol.parser.Parser');
/**
* @constructor
* @extends {ol.parser.Parser}
* @todo stability experimental
*/
ol.parser.WKT = function() {
};

View File

@@ -8,6 +8,7 @@ goog.require('ol.parser.Parser');
/**
* @constructor
* @extends {ol.parser.Parser}
* @todo stability experimental
*/
ol.parser.XML = function() {
if (goog.global.ActiveXObject) {