ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Get rid of stability annotations and document stability with api

Browse Source 
This change adds a stability value to the api annotation, with
'experimental' as default value.

enum, typedef and event annotations are never exportable, but
api annotations are needed there to make them appear in the
docs.

Nested typedefs are no longer inlined recursively, because the
resulting tables get too wide with the current template.
This commit is contained in:
Andreas Hocevar
2014-04-17 00:56:44 +02:00
committed by Tim Schaub
parent 29b643c7b0
commit fbdbbfb7a7
146 changed files with 506 additions and 764 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
src/ol/format/geojsonformat.js
View File

@@ -26,7 +26,6 @@ goog.require('ol.proj');
* @constructor
* @extends {ol.format.JSONFeature}
* @param {olx.format.GeoJSONOptions=} opt_options Options.
* @todo stability experimental
* @todo api
*/
ol.format.GeoJSON = function(opt_options) {
@@ -323,7 +322,6 @@ ol.format.GeoJSON.prototype.getExtensions = function() {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.Feature} Feature.
* @todo stability experimental
* @todo api
*/
ol.format.GeoJSON.prototype.readFeature;
@@ -336,7 +334,6 @@ ol.format.GeoJSON.prototype.readFeature;
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {Array.<ol.Feature>} Features.
* @todo stability experimental
* @todo api
*/
ol.format.GeoJSON.prototype.readFeatures;
@@ -391,7 +388,6 @@ ol.format.GeoJSON.prototype.readFeaturesFromObject = function(object) {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.geom.Geometry} Geometry.
* @todo stability experimental
* @todo api
*/
ol.format.GeoJSON.prototype.readGeometry;
@@ -411,7 +407,6 @@ ol.format.GeoJSON.prototype.readGeometryFromObject = function(object) {
*
* @param {ArrayBuffer|Document|Node|Object|string} object Source.
* @return {ol.proj.Projection} Projection.
* @todo stability experimental
* @todo api
*/
ol.format.GeoJSON.prototype.readProjection = function(object) {
@@ -442,7 +437,6 @@ ol.format.GeoJSON.prototype.readProjection = function(object) {
* @function
* @param {ol.Feature} feature Feature.
* @return {ArrayBuffer|Node|Object|string} Result.
* @todo stability experimental
* @todo api
*/
ol.format.GeoJSON.prototype.writeFeature;
@@ -479,7 +473,6 @@ ol.format.GeoJSON.prototype.writeFeatureObject = function(feature) {
* @function
* @param {Array.<ol.Feature>} features Features.
* @return {ArrayBuffer|Node|Object|string} Result.
* @todo stability experimental
* @todo api
*/
ol.format.GeoJSON.prototype.writeFeatures;

5
src/ol/format/gpxformat.js
View File

@@ -19,7 +19,6 @@ goog.require('ol.xml');
/**
* @constructor
* @extends {ol.format.XMLFeature}
* @todo stability experimental
* @todo api
*/
ol.format.GPX = function() {
@@ -370,7 +369,6 @@ ol.format.GPX.WPT_PARSERS_ = ol.xml.makeParsersNS(
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.Feature} Feature.
* @todo stability experimental
* @todo api
*/
ol.format.GPX.prototype.readFeature;
@@ -402,7 +400,6 @@ ol.format.GPX.prototype.readFeatureFromNode = function(node) {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {Array.<ol.Feature>} Features.
* @todo stability experimental
* @todo api
*/
ol.format.GPX.prototype.readFeatures;
@@ -435,7 +432,6 @@ ol.format.GPX.prototype.readFeaturesFromNode = function(node) {
*
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.proj.Projection} Projection.
* @todo stability experimental
* @todo api
*/
ol.format.GPX.prototype.readProjection;
@@ -811,7 +807,6 @@ goog.inherits(ol.format.GPX.V1_1, ol.format.GPX);
* @function
* @param {Array.<ol.Feature>} features Features.
* @return {ArrayBuffer|Node|Object|string} Result.
* @todo stability experimental
* @todo api
*/
ol.format.GPX.prototype.writeFeatures;

4
src/ol/format/igcformat.js
View File

@@ -25,7 +25,6 @@ ol.format.IGCZ = {
* @constructor
* @extends {ol.format.TextFeature}
* @param {olx.format.IGCOptions=} opt_options Options.
* @todo stability experimental
* @todo api
*/
ol.format.IGC = function(opt_options) {
@@ -92,7 +91,6 @@ ol.format.IGC.prototype.getExtensions = function() {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.Feature} Feature.
* @todo stability experimental
* @todo api
*/
ol.format.IGC.prototype.readFeature;
@@ -179,7 +177,6 @@ ol.format.IGC.prototype.readFeatureFromText = function(text) {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {Array.<ol.Feature>} Features.
* @todo stability experimental
* @todo api
*/
ol.format.IGC.prototype.readFeatures;
@@ -204,7 +201,6 @@ ol.format.IGC.prototype.readFeaturesFromText = function(text) {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.proj.Projection} Projection.
* @todo stability experimental
* @todo api
*/
ol.format.IGC.prototype.readProjection;

4
src/ol/format/kmlformat.js
View File

@@ -54,7 +54,6 @@ ol.format.KMLGxTrackObject_;
* @constructor
* @extends {ol.format.XMLFeature}
* @param {olx.format.KMLOptions=} opt_options Options.
* @todo stability experimental
* @todo api
*/
ol.format.KML = function(opt_options) {
@@ -1451,7 +1450,6 @@ ol.format.KML.prototype.readSharedStyleMap_ = function(node, objectStack) {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.Feature} Feature.
* @todo stability experimental
* @todo api
*/
ol.format.KML.prototype.readFeature;
@@ -1481,7 +1479,6 @@ ol.format.KML.prototype.readFeatureFromNode = function(node) {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {Array.<ol.Feature>} Features.
* @todo stability experimental
* @todo api
*/
ol.format.KML.prototype.readFeatures;
@@ -1600,7 +1597,6 @@ ol.format.KML.prototype.readNameFromNode = function(node) {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.proj.Projection} Projection.
* @todo stability experimental
* @todo api
*/
ol.format.KML.prototype.readProjection;

1
src/ol/format/osmxmlformat.js
View File

@@ -18,7 +18,6 @@ goog.require('ol.xml');
/**
* @constructor
* @extends {ol.format.XMLFeature}
* @todo stability experimental
* @todo api
*/
ol.format.OSMXML = function() {

3
src/ol/format/topojsonformat.js
View File

@@ -19,7 +19,6 @@ goog.require('ol.proj');
* @constructor
* @extends {ol.format.JSONFeature}
* @param {olx.format.TopoJSONOptions=} opt_options Options.
* @todo stability experimental
* @todo api
*/
ol.format.TopoJSON = function(opt_options) {
@@ -272,7 +271,6 @@ ol.format.TopoJSON.readFeatureFromGeometry_ = function(object, arcs,
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {Array.<ol.Feature>} Features.
* @todo stability experimental
* @todo api
*/
ol.format.TopoJSON.prototype.readFeatures;
@@ -383,7 +381,6 @@ ol.format.TopoJSON.transformVertex_ = function(vertex, scale, translate) {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} object Source.
* @return {ol.proj.Projection} Projection.
* @todo stability experimental
* @todo api
*/
ol.format.TopoJSON.prototype.readProjection = function(object) {

5
src/ol/format/wfsformat.js
View File

@@ -17,7 +17,6 @@ goog.require('ol.xml');
* @param {olx.format.WFSOptions=} opt_options
* Optional configuration object.
* @extends {ol.format.XMLFeature}
* @todo stability experimental
* @todo api
*/
ol.format.WFS = function(opt_options) {
@@ -93,7 +92,6 @@ ol.format.WFS.prototype.readFeaturesFromNode = function(node) {
/**
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.format.WFS.TransactionResponse|undefined} Transaction response.
* @todo stability experimental
* @todo api
*/
ol.format.WFS.prototype.readTransactionResponse = function(source) {
@@ -116,7 +114,6 @@ ol.format.WFS.prototype.readTransactionResponse = function(source) {
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.format.WFS.FeatureCollectionMetadata|undefined}
* FeatureCollection metadata.
* @todo stability experimental
* @todo api
*/
ol.format.WFS.prototype.readFeatureCollectionMetadata = function(source) {
@@ -554,7 +551,6 @@ ol.format.WFS.writeGetFeature_ = function(node, featureTypes, objectStack) {
/**
* @param {olx.format.WFSWriteGetFeatureOptions} options Options.
* @return {Node} Result.
* @todo stability experimental
* @todo api
*/
ol.format.WFS.prototype.writeGetFeature = function(options) {
@@ -607,7 +603,6 @@ ol.format.WFS.prototype.writeGetFeature = function(options) {
* @param {Array.<ol.Feature>} deletes The features to delete.
* @param {olx.format.WFSWriteTransactionOptions} options Write options.
* @return {Node} Result.
* @todo stability experimental
* @todo api
*/
ol.format.WFS.prototype.writeTransaction = function(inserts, updates, deletes,

2
src/ol/format/wmscapabilitiesformat.js
View File

@@ -15,7 +15,6 @@ goog.require('ol.xml');
/**
* @constructor
* @extends {ol.format.XML}
* @todo stability experimental
* @todo api
*/
ol.format.WMSCapabilities = function() {
@@ -36,7 +35,6 @@ goog.inherits(ol.format.WMSCapabilities, ol.format.XML);
* @function
* @param {Document|Node|string} source The XML source.
* @return {Object} An object representing the WMS capabilities.
* @todo stability experimental
* @todo api
*/
ol.format.WMSCapabilities.prototype.read;