Get rid of stability annotations and document stability with api

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
-1
View File
@@ -7,7 +7,6 @@ goog.require('ol.proj.EPSG4326');
/**
* FIXME empty description for jsdoc
* @todo stability experimental
* @todo api
*/
ol.proj.common.add = function() {
+3 -14
View File
@@ -30,14 +30,15 @@ ol.HAVE_PROJ4JS = ol.ENABLE_PROJ4JS && typeof Proj4js == 'object';
* A projection as {@link ol.proj.Projection}, SRS identifier string or
* undefined.
* @typedef {ol.proj.Projection|string|undefined} ol.proj.ProjectionLike
* @todo stability experimental
* @todo api
*/
ol.proj.ProjectionLike;
/**
* Projection units: `'degrees'`, `'ft'`, `'m'` or `'pixels'`.
* @enum {string}
* @todo stability experimental
* @todo api
*/
ol.proj.Units = {
DEGREES: 'degrees',
@@ -51,7 +52,6 @@ ol.proj.Units = {
* Meters per unit lookup table.
* @const
* @type {Object.<ol.proj.Units, number>}
* @todo stability experimental
* @todo api
*/
ol.proj.METERS_PER_UNIT[ol.proj.Units.DEGREES] =
@@ -65,7 +65,6 @@ ol.proj.METERS_PER_UNIT[ol.proj.Units.METERS] = 1;
* @constructor
* @param {olx.ProjectionOptions} options Projection options.
* @struct
* @todo stability experimental
* @todo api
*/
ol.proj.Projection = function(options) {
@@ -113,7 +112,6 @@ ol.proj.Projection = function(options) {
/**
* Get the code for this projection, e.g. 'EPSG:4326'.
* @return {string} Code.
* @todo stability experimental
* @todo api
*/
ol.proj.Projection.prototype.getCode = function() {
@@ -124,7 +122,6 @@ ol.proj.Projection.prototype.getCode = function() {
/**
* Get the validity extent for this projection.
* @return {ol.Extent} Extent.
* @todo stability experimental
* @todo api
*/
ol.proj.Projection.prototype.getExtent = function() {
@@ -148,7 +145,6 @@ ol.proj.Projection.prototype.getPointResolution = goog.abstractMethod;
/**
* Get the units of this projection.
* @return {ol.proj.Units} Units.
* @todo stability experimental
* @todo api
*/
ol.proj.Projection.prototype.getUnits = function() {
@@ -380,7 +376,6 @@ ol.proj.addProj4jsProjection_ = function(proj4jsProjection) {
/**
* @param {ol.proj.Projection} projection Projection.
* @todo stability experimental
* @todo api
*/
ol.proj.addProjection = function(projection) {
@@ -479,7 +474,6 @@ ol.proj.removeTransform = function(source, destination) {
* a combination of authority and identifier such as "EPSG:4326", or an
* existing projection object, or undefined.
* @return {ol.proj.Projection} Projection.
* @todo stability experimental
* @todo api
*/
ol.proj.get = function(projectionLike) {
@@ -562,7 +556,6 @@ ol.proj.equivalent = function(projection1, projection2) {
* @param {ol.proj.ProjectionLike} source Source.
* @param {ol.proj.ProjectionLike} destination Destination.
* @return {ol.TransformFunction} Transform.
* @todo stability experimental
* @todo api
*/
ol.proj.getTransform = function(source, destination) {
@@ -580,7 +573,6 @@ ol.proj.getTransform = function(source, destination) {
* @param {ol.proj.Projection} sourceProjection Source projection.
* @param {ol.proj.Projection} destinationProjection Destination projection.
* @return {ol.TransformFunction} Transform.
* @todo stability experimental
* @todo api
*/
ol.proj.getTransformFromProjections =
@@ -701,7 +693,6 @@ ol.proj.cloneTransform = function(input, opt_output, opt_dimension) {
* @param {ol.proj.ProjectionLike} source Source.
* @param {ol.proj.ProjectionLike} destination Destination.
* @return {ol.Coordinate} Point.
* @todo stability experimental
* @todo api
*/
ol.proj.transform = function(point, source, destination) {
@@ -717,7 +708,6 @@ ol.proj.transform = function(point, source, destination) {
* @param {ol.proj.Projection} sourceProjection Source projection.
* @param {ol.proj.Projection} destinationProjection Destination projection.
* @return {ol.Coordinate} Point.
* @todo stability experimental
* @todo api
*/
ol.proj.transformWithProjections =
@@ -731,7 +721,6 @@ ol.proj.transformWithProjections =
/**
* @param {olx.Proj4jsProjectionOptions} options Proj4js projection options.
* @return {ol.proj.Projection} Proj4js projection.
* @todo stability experimental
* @todo api
*/
ol.proj.configureProj4jsProjection = function(options) {