Document raw geometry types

This commit is contained in:
Andreas Hocevar
2014-05-06 11:58:01 -05:00
parent 3f2f7e3603
commit e6dbb61d68
2 changed files with 15 additions and 2 deletions

View File

@@ -17,7 +17,7 @@ ol.CoordinateFormatType;
/**
* An array of numbers representing a coordinate.
* An array of numbers representing a coordinate. Example: `[16, 48]`.
* @typedef {Array.<number>} ol.Coordinate
* @todo api
*/

View File

@@ -166,43 +166,56 @@ ol.geom.Geometry.prototype.transform = goog.abstractMethod;
/**
* Array representation of a point. Example: `[16, 48]`.
* @typedef {ol.Coordinate}
* @todo api
*/
ol.geom.RawPoint;
/**
* Array representation of a linsetring.
* @typedef {Array.<ol.Coordinate>}
* @todo api
*/
ol.geom.RawLineString;
/**
* Array representation of a linear ring.
* @typedef {Array.<ol.Coordinate>}
*
* @todo api
*/
ol.geom.RawLinearRing;
/**
* Array representation of a polygon.
* @typedef {Array.<ol.geom.RawLinearRing>}
* @todo api
*/
ol.geom.RawPolygon;
/**
* Array representation of a multipoint.
* @typedef {Array.<ol.geom.RawPoint>}
* @todo api
*/
ol.geom.RawMultiPoint;
/**
* Array representation of a multilinestring.
* @typedef {Array.<ol.geom.RawLineString>}
* @todo api
*/
ol.geom.RawMultiLineString;
/**
* Array representation of a multipolygon.
* @typedef {Array.<ol.geom.RawPolygon>}
* @todo api
*/
ol.geom.RawMultiPolygon;