Add warnings about internal classes and functions

This commit is contained in:
Tom Payne
2013-06-06 18:36:40 +02:00
parent a858664035
commit 85ca39cf0c
4 changed files with 7 additions and 0 deletions

View File

@@ -16,6 +16,7 @@ ol.geom2.LineString;
/**
* This is an internal class that will be removed from the API.
* @constructor
* @param {ol.structs.Buffer} buf Buffer.
* @param {Object.<number, Array.<number>>=} opt_ranges Ranges.
@@ -54,6 +55,7 @@ ol.geom2.LineStringCollection.createEmpty = function(capacity, opt_dim) {
/**
* This is an internal function that will be removed from the API.
* @param {Array.<ol.geom2.LineString>} unpackedLineStrings Unpacked line
* strings.
* @param {number=} opt_capacity Capacity.

View File

@@ -15,6 +15,7 @@ ol.geom2.Point;
/**
* This is an internal class that will be removed from the API.
* @constructor
* @param {ol.structs.Buffer} buf Buffer.
* @param {number=} opt_dim Dimension.
@@ -35,6 +36,7 @@ ol.geom2.PointCollection = function(buf, opt_dim) {
/**
* This is an internal function that will be removed from the API.
* @param {number} capacity Capacity.
* @param {number=} opt_dim Dimension.
* @return {ol.geom2.PointCollection} Point collection.
@@ -47,6 +49,7 @@ ol.geom2.PointCollection.createEmpty = function(capacity, opt_dim) {
/**
* This is an internal function that will be removed from the API.
* @param {Array.<ol.geom2.Point>} unpackedPoints Unpacked points.
* @param {number=} opt_capacity Capacity.
* @param {number=} opt_dim Dimension.

View File

@@ -6,6 +6,7 @@ goog.require('ol.source.VectorSource2');
/**
* This is an internal class that will be removed from the API.
* @constructor
* @extends {ol.layer.Layer}
* @param {ol.layer.LayerOptions} options Options.

View File

@@ -7,6 +7,7 @@ goog.require('ol.source.Source');
/**
* This is an internal class that will be removed from the API.
* @constructor
* @extends {ol.source.Source}
* @param {ol.source.VectorSource2Options} options Options.