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
08ec3480ed
Add stability annotation to ol.geom.Geometry
2014-02-03 14:45:00 +01:00
Tom Payne
edcb38232f
Use inherited dispatchChangeEvent and getRevision in ol.geom.Geometry
2014-01-21 11:43:13 +01:00
Tom Payne
3647f13e2e
Add ol.geom.Circle
2014-01-14 12:31:50 +01:00
oterral
235af49f0b
Add goog.provide('ol.geom.GeometryType')
2014-01-10 14:00:30 +01:00
Tom Payne
d7eb4db69e
Add ol.geom.GeometryCollection
2013-12-11 16:49:47 +01:00
Tom Payne
6295fa6088
Add ol.geom.Geometry#clone
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
35c20bea79
Add ol.geom.Geometry#getClosestPoint
2013-12-09 16:40:53 +01:00
Tom Payne
b374d5c5b8
Avoid simplifying geometries when it will have no effect
2013-12-09 16:37:33 +01:00
Tom Payne
9612182f70
Add ol.geom.Geometry#getSimplifiedGeometry
2013-12-09 16:37:32 +01:00
Tom Payne
554e17ac22
Set geometry to null if no geometry given
2013-12-07 19:51:54 +01:00
Tom Payne
1ae13f152d
Fire change event when an ol.geom.Geometry is transformed
2013-12-06 21:12:32 +01:00
Tom Payne
6c5f1fbcce
Make ol.geom.Geometry inherit from ol.Observable
2013-12-06 16:30:00 +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
27982ec5e7
Factor out ol.geom.Geometry.getStrideForLayout_
2013-12-03 15:44:44 +01:00
Tom Payne
0477101c28
Factor out ol.geom.Geometry.getLayoutForStride_
2013-12-03 15:44:25 +01:00
Tom Payne
b2a93dcda7
Add ol.geom.LinearRing
2013-12-01 21:06:11 +01:00
Tom Payne
f93ae0392a
Improve type checking in ol.geom
2013-11-20 11:45:23 +01:00
Tom Payne
df423fda22
Move ol.geom.orientFlatLinearRings into ol.geom.flat
2013-11-20 11:44:45 +01:00
Tom Payne
0aa0cfd54b
Move ol.geom.flatLinearRingIsClockwise into ol.geom.flat
2013-11-20 11:44:44 +01:00
Tom Payne
857c28a88b
Move ol.geom.flatLinearRingContains to ol.geom.flat
2013-11-20 11:44:44 +01:00
Tom Payne
48d3402044
Move reverseFlatCoordinates into ol.geom.flat
2013-11-20 11:44:44 +01:00
Tom Payne
1757a62905
Move transformGeometry2D back into ol.geom
2013-11-20 11:44:44 +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
23777e5949
Add ol.geom.orientFlatLinearRings{,s}
2013-11-20 11:42:09 +01:00
Tom Payne
43d67736a8
Add ol.geom.flatLinearRingIsClockwise
2013-11-20 11:42:09 +01:00
Tom Payne
72f64bd37a
Add ol.geom.reverseFlatCoordinates
2013-11-20 11:42:08 +01:00
Tom Payne
aa70030a43
Move containsCoordinate to ol.geom.Geometry
2013-11-20 11:42:07 +01:00
Tom Payne
f2865e6dbf
Add coordinate in LinearRing functions
2013-11-20 11:42:07 +01:00
Tom Payne
d10fb12f27
Improve type checking with cast
2013-11-20 11:42:01 +01:00
Tom Payne
daecad22ae
Add ol.geom.{de,in}flateCoordinatesss
2013-11-20 11:41:59 +01:00
Tom Payne
7740929036
Add ol.geom.{de,in}flateCoordinatess
2013-11-20 11:41:58 +01:00
Tom Payne
6d32756adf
Add ol.geom.MultiPoint
2013-11-20 11:41:57 +01:00
Tom Payne
a415b66e88
Refactor ol.geom.Geometry to support Z, M and flat coordinates
2013-11-20 11:41:57 +01:00
Tom Payne
f67fa27c9e
Add ol.geom.{in,de}flateCoordinates
2013-11-20 11:41:57 +01:00
Tom Payne
27ab7da5ee
Add 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
cb099cb453
Add ol.geom.MultiPolygon
2013-11-20 11:41:54 +01:00
Tom Payne
c658460c09
Add ol.geom.MultiLineString
2013-11-20 11:41:53 +01:00
Tom Payne
f9105c18eb
Use GeoJSON types for geometries
2013-11-20 11:41:08 +01:00
Tom Payne
63a0219f3d
Add some FIXMEs
2013-11-20 11:41:07 +01:00
Tom Payne
4260283497
Add layout and stride to ol.geom.Geometry
2013-11-20 11:41:07 +01:00
