Commit Graph

16 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 7a34929b15 Rename rotateWithMap to rotateWithView 2014-02-21 14:32:06 +01:00
Tom Payne 27c5ab0312 Replace subtractViewRotation with rotateWithMap 2014-02-21 11:21:20 +01:00
Frederic Junod 430ff9c850 Add opacity property to ol.style.Image 2014-02-19 11:40:40 +01:00
Éric Lemoine 3626ff5b16 Icon images are handled by a separate class 2014-02-06 12:59:38 +01:00
Tom Payne 415b5ad85e Add stability annotation to ol.style.Circle 2014-02-03 14:59:13 +01:00
Éric Lemoine 797b220b6c Hit detect circle points with no fill 2014-01-24 17:39:57 +01:00
Tom Payne 50b41f93f3 Correct calculation of ol.style.Circle canvas size 2014-01-02 17:27:52 +01:00
Tom Payne 9524a46f41 Add scale to ol.style.Image 2013-12-19 16:26:05 +01:00
Éric Lemoine d4d9cb6a3a Add getters to ol.style.Stroke 2013-12-19 14:37:57 +01:00
Éric Lemoine 16047ff852 Add getters to ol.style.Fill 2013-12-19 11:41:38 +01:00
Éric Lemoine 8fdd178d0a Add getters to ol.style.Circle 2013-12-19 11:36:31 +01:00
Éric Lemoine 59910339cd Add ol.style.Circle#getHitDetectionImage 2013-12-19 09:08:30 +01:00
Éric Lemoine 65a75399c2 Add ol.style.Circle 2013-12-19 00:20:10 +01:00