Commit Graph

177 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
Frederic Junod 55de0a54b9 Add ol.dom.createCanvasContext2D function 2014-04-02 09:37:41 +02:00
Frederic Junod 4a893f7837 Add offsetX and offsetY properties to ol.style.Text 2014-03-11 14:06:51 +01:00
oterral 5028aa3bc3 Fix anchor origin calculation 2014-03-07 13:35:18 +01:00
Tom Payne fb1c66525c Catch CORS exceptions when loading icons 2014-03-01 13:56:44 +01: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
Éric Lemoine fe159aa7fa Merge pull request #1726 from oterral/fix_anchororigin
Add anchorOrigin option in ol.style.Icon
2014-02-21 09:24:23 +01:00
oterral 0a6390fb21 Add anchorOrigin option in ol.style.Icon 2014-02-21 09:09:59 +01:00
Frederic Junod 430ff9c850 Add opacity property to ol.style.Image 2014-02-19 11:40:40 +01:00
oterral 3a7c80dfda Remove exports from ol.style.Image 2014-02-11 13:13:51 +01:00
oterral 8edcc7e161 Add exports for ol.style.Text 2014-02-11 12:33:12 +01:00
oterral f122778c6d Add exports for ol.style.Icon 2014-02-11 12:20:00 +01:00
oterral 740b398341 Add exports for ol.style.Circle 2014-02-11 12:18:29 +01:00
Éric Lemoine c2d0cab07a Add tests for ol.style.IconImageCache 2014-02-06 12:59:39 +01:00
Éric Lemoine c2fe25ee26 Use the icon image cache 2014-02-06 12:59:39 +01:00
Éric Lemoine 065663b242 Introduce an icon image cache 2014-02-06 12:59:38 +01:00
Éric Lemoine 3626ff5b16 Icon images are handled by a separate class 2014-02-06 12:59:38 +01:00
Tom Payne 0137987015 Add scale to ol.style.Text 2014-02-03 15:49:04 +01:00
Tom Payne 16d98c5506 Remove ol.style.Text.equals 2014-02-03 15:49:04 +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
oterral db85936de2 Export ol.style.Image#getScale 2014-01-09 10:54:57 +01:00
Éric Lemoine 49120e4761 Icon anchors are Array.<number> 2014-01-08 10:07:01 +01:00
Éric Lemoine a0a94414dd Add anchorXUnits and anchorYUnits options to ol.style.Icon 2014-01-08 00:24:55 +01:00
Tom Payne 061fed50b7 Move all styleFunction types into ol.feature 2014-01-03 17:23:11 +01:00
Tom Payne 50b41f93f3 Correct calculation of ol.style.Circle canvas size 2014-01-02 17:27:52 +01:00
Tom Payne d82f1f8e02 Add scale to ol.style.IconStyle 2013-12-19 16:26:05 +01:00
Tom Payne 9524a46f41 Add scale to ol.style.Image 2013-12-19 16:26:05 +01:00
Tom Payne 2a6979e15a ol.style.Image rotation is always defined 2013-12-19 16:26:05 +01:00
Éric Lemoine 84e98b4422 Export ol.style.Style getters 2013-12-19 14:37:58 +01:00
Éric Lemoine f22f1e1f04 Export ol.style.Stroke getters 2013-12-19 14:37:58 +01:00
Éric Lemoine c9c8fad01a Export ol.style.Image getters 2013-12-19 14:37:58 +01:00
Éric Lemoine ad945e6331 Export ol.style.Icon getters 2013-12-19 14:37:58 +01:00
Éric Lemoine 47a1ec3a00 Export ol.style.Fill getters 2013-12-19 14:37:58 +01:00
Éric Lemoine 0dad9f49c7 Export ol.style.Circle getters 2013-12-19 14:37:58 +01:00
Éric Lemoine 44d310bb6d Add getters to ol.style.Text 2013-12-19 14:37:58 +01:00
Éric Lemoine d4d9cb6a3a Add getters to ol.style.Stroke 2013-12-19 14:37:57 +01:00
Éric Lemoine 5cd3ab06fc Add getters to ol.style.Image 2013-12-19 14:37:57 +01:00
Éric Lemoine e4f2a7552e Add getters to ol.style.Icon 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 1e24ec28be Add getters to ol.style.Style 2013-12-19 11:32:57 +01:00
Éric Lemoine 2bd0f8ae3e Add ol.style.Icon#getHitDetectionImage 2013-12-19 09:08:58 +01:00
Éric Lemoine 59910339cd Add ol.style.Circle#getHitDetectionImage 2013-12-19 09:08:30 +01:00
Éric Lemoine ebcc6ab509 Add ol.style.Image#getHitDetectionImage abstract method 2013-12-19 09:08:04 +01:00
Éric Lemoine e44aa1e14a Make ol.style.Image a base class for Icon and Circle 2013-12-19 00:20:10 +01:00
Éric Lemoine c786b91f3c Export ol.style.Circle 2013-12-19 00:20:10 +01:00