Commit Graph

17 Commits

Author SHA1 Message Date
Tim Schaub
4cf5ab4620 Use @api annotation instead of @todo api 2014-07-05 15:41:14 -04:00
Peter Robins
75be215497 Add standard docs text to abstract base classes 2014-06-14 07:20:33 -04:00
Peter Robins
41d9f0360a Add @classdesc to classes 2014-06-09 12:10:19 -04:00
Tim Schaub
0b8f1e8944 Mark applyTransform as part of the API for all geometries 2014-05-02 13:24:04 -06:00
Tim Schaub
4f9968d106 Rename transform to applyTransform for geometries 2014-05-02 09:27:53 -06:00
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
78c8d976eb Remove empty ol.geom.flat 2014-03-12 13:26:14 +01:00
Tom Payne
ca44c6328c Factor out ol.geom.flat.transform 2014-03-12 13:26:14 +01:00
Tom Payne
a1e8ff0a8f Add ol.geom.SimpleGeometry#getLastCoordinate 2014-02-28 15:36:18 +01:00
Tom Payne
7ca47e3b2a Add ol.geom.SimpleGeometry#getFirstCoordinate 2014-02-28 15:36:06 +01:00
Tom Payne
3c16e03ae2 Pass offset and end to ol.extent.extendFlatCoordinates 2014-02-03 15:49:05 +01:00
Tom Payne
c4b7a32751 Add stability annotation to ol.geom.SimpleGeometry 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
7ee2747948 Always use goog.vec.Mat4.Number instead of goog.vec.Mat.AnyType 2014-01-06 09:29:36 +01:00
Tom Payne
76a6e08ec1 Factor out ol.geom.SimpleGeometry 2013-12-11 16:49:47 +01:00