Commit Graph

50 Commits

Author SHA1 Message Date
Andreas Hocevar
fbdbbfb7a7 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.
2014-04-29 09:53:07 -06:00
Andreas Hocevar
c17ac0cae3 Greatly simplify and document the usage of JSDoc
This commit simplifies the exports.js plugin so it only relies
on the stability notes to generate the documentation, which
completely decouples it from the exportable API.

As a rule of thumb, whenever something has an 'api' annotation,
it should also have a 'stability' annotation. A more verbose
documentation of ol3 specific annotation usage is available in
the new 'apidoc/readme.md' file.

This commit also modifies all source files to implement these
usage suggestions.
2014-04-29 09:53:06 -06:00
Tim Schaub
fb497f5288 Annotations for exports 2014-04-29 09:53:05 -06:00
Tom Payne
b613c9cde7 Merge pull request #1859 from pgiraud/geolocation_tracking_orientation
Geolocation tracking with orientation example
2014-03-24 12:53:53 +01:00
Pierre GIRAUD
8e9ffb377e Geolocation tracking with orientation example 2014-03-24 12:26:17 +01:00
Tom Payne
765985c5a9 Use ol.array.safeExtend in ol.geom.MultiLineString 2014-03-24 11:56:53 +01:00
Tom Payne
78c8d976eb Remove empty ol.geom.flat 2014-03-12 13:26:14 +01:00
Tom Payne
3541a01aab Factor out ol.geom.flat.inflate 2014-03-12 13:26:14 +01:00
Tom Payne
266c43dc78 Factor out ol.geom.flat.deflate 2014-03-12 13:26:14 +01:00
Tom Payne
522fda1688 Factor out ol.geom.flat.interpolate 2014-03-12 13:26:13 +01:00
Tom Payne
c8165a8168 Factor out ol.geom.flat.simplify 2014-03-12 13:26:13 +01:00
Tom Payne
2b6845244c Factor out ol.geom.flat.closest 2014-03-12 13:26:13 +01:00
Tom Payne
7a51b4c7b6 Add ol.geom.MultiLineString#appendLineString 2014-03-10 16:53:20 +01:00
Tom Payne
7ee4fb8a2e Add ol.geom.MultiLineString#getLineString 2014-03-10 16:53:20 +01:00
Tom Payne
669f21ca29 Construct individual line strings directly from flat coordinates 2014-03-10 16:53:20 +01:00
Tom Payne
ee5a9d6a4e Check arguments passed to ol.geom.MultiLineString#setFlatCoordinates 2014-03-10 16:53:19 +01:00
Tom Payne
8125b4a847 Add ol.geom.MultiLineString#getCoordinateAtM 2014-03-02 12:14:52 +01:00
Tom Payne
a37199675c Add ol.geom.MultiLineString#getFlatMidpoints 2014-02-03 15:49:03 +01:00
Tom Payne
f8570137ed Add stability annotation to ol.geom.MultiLineString 2014-02-03 14:59:12 +01:00
Tom Payne
edcb38232f Use inherited dispatchChangeEvent and getRevision in ol.geom.Geometry 2014-01-21 11:43:13 +01:00
oterral
235af49f0b Add goog.provide('ol.geom.GeometryType') 2014-01-10 14:00:30 +01:00
Tom Payne
0bf34a52ff Add ol.geom.MultiLineString#setLineStrings 2013-12-20 16:33:26 +01:00
Tom Payne
802d1644bb Implement clone for simple geometries 2013-12-11 16:49:47 +01:00
Tom Payne
76a6e08ec1 Factor out ol.geom.SimpleGeometry 2013-12-11 16:49:47 +01:00
Tom Payne
f4fe0046b2 Check closest point against extent 2013-12-09 16:40:55 +01:00
Tom Payne
128e174ee2 Add ol.geom.MultiLineString#closestPointXY 2013-12-09 16:40:54 +01:00
Tom Payne
0845c866d5 Add ol.geom.MultiLineString#getSimplifiedGeometryInternal 2013-12-09 16:37:33 +01:00
Tom Payne
057cda42be Rename ol.geom.Type to ol.geom.GeometryType 2013-12-04 16:28:36 +01:00
Tom Payne
c2228b1d19 Rename ol.geom.Layout to ol.geom.GeometryLayout 2013-12-04 16:27:03 +01:00
Tom Payne
1a9d19a2fb Allow geometries to have null coordinates and add setFlatCoordinates 2013-12-03 19:58:34 +01:00
Tom Payne
2caf6307d4 Add ol.geom.MultiLineString#getLineStrings 2013-12-01 21:06:25 +01:00
Tom Payne
16e5f238d2 Move inflateCoordinates into ol.geom.flat 2013-11-20 11:44:44 +01:00
Tom Payne
dc1ad7bb83 Move deflateCoodinates into ol.geom.flat 2013-11-20 11:44:44 +01:00
Tom Payne
cd9b52572a Replace ol.geom.GeometryType with ol.geom.Type 2013-11-20 11:42:09 +01:00
Tom Payne
9d07e6509f Refactor ol.geom.MultiLineString 2013-11-20 11:41:58 +01:00
Tom Payne
cfaad0eff1 Use raw geometry types 2013-11-20 11:41:57 +01:00
Tom Payne
e4623af4df Add ol.geom.Geometry#transform 2013-11-20 11:41:56 +01:00
Tom Payne
c658460c09 Add ol.geom.MultiLineString 2013-11-20 11:41:53 +01:00
Tom Payne
4e65fefc00 Move vector code out of the way 2013-11-20 11:39:21 +01:00
Paul Spencer
bada596b45 Add default stability level to docs of exported things. 2013-10-24 18:20:24 -04:00
ahocevar
52552c9b18 Fire change events for multi-part geometries 2013-10-04 23:36:16 -06:00
Tim Schaub
1aa83e133b Remove dimension property from geometries
This was only necessary when using the shared vertices structure.
2013-09-27 23:18:34 +01:00
Tim Schaub
2850c761cf Remove use of shared vertices in geom package 2013-09-27 23:18:17 +01:00
Tim Schaub
58fe110419 Rename ol.geom.VertexArray to ol.CoordinateArray 2013-08-30 13:30:53 -06:00
ahocevar
58c8b07ab5 Get hit candidates from RTree, then refine result
Now we get exact hits also for lines and polygons.
2013-04-30 13:34:12 +02:00
Tim Schaub
b52d283641 Allow geometries to use a shared vertex array
The ol.geom.SharedVertices structure represents a flattened array of vertex coordinates.  This is intended to support optimal WebGL rendering.
2013-03-02 18:39:24 +01:00
Tim Schaub
6ef2184c83 Geometry type enumeration 2013-01-21 17:46:41 -07:00
Tim Schaub
b4d44f815f Add getBounds to geometry 2013-01-21 12:59:04 -07:00
Tim Schaub
fd0a5f3622 Point, linestring, and linearring coordinates as Float32Array 2013-01-18 15:57:48 -07:00
Tim Schaub
997c7145ab Bare bones geom package 2013-01-07 01:34:33 -05:00