Commit Graph

13 Commits

Author SHA1 Message Date
Peter Robins 535e8f5e35 Move top-level typedefs to typedefs.js
With one exception, those directly in the `ol` namespace can be moved without problem.
Some left-over goog.requires are also removed.
2016-05-11 17:18:05 +00:00
Peter Robins f57065c412 Remove unneeded goog.provides/requires for typedefs
In general, typedefs do not need and should not have goog.require/provide
2016-05-09 13:21:25 +00:00
Peter Robins 1cd7b76efe Improve docs/examples for loadingstrategy 2016-04-02 13:09:44 +00:00
Guillaume Beraudo 65614d74f8 Add missing @api
These types are referenced in the externs but were not declared.
Found by ol3-cesium.
2015-04-16 11:09:41 +02:00
Éric Lemoine bdb326c310 Port vector examples to new vector API 2015-04-08 10:22:56 +02:00
Éric Lemoine 09b90c8424 Add loader and strategy to ol.source.Vector 2015-04-08 10:22:56 +02:00
Éric Lemoine ba035abb1f Change ol.TileCoord to an Array 2014-08-18 09:33:24 +02:00
Tim Schaub 4cf5ab4620 Use @api annotation instead of @todo api 2014-07-05 15:41:14 -04:00
Andreas Hocevar 45805f7158 Make loading strategies appear in the docs 2014-05-27 15:38:31 +02: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 b8869805a7 Rename ol.loading to ol.loadingstrategy 2014-04-03 15:12:22 +02:00