Commit Graph

34 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
7cadb6824e Merge remote-tracking branch 'openlayers/master' into vector-api 2013-12-18 17:09:19 +01:00
Éric Lemoine
79718151b7 Add ol.BrowserFeature.HAS_WEBGL 2013-12-18 11:20:13 +01:00
Tom Payne
fbc23499e4 Add @struct annotation for simple classes 2013-12-13 18:59:26 +01:00
Tom Payne
1dd5f7f7c8 Merge remote-tracking branch 'openlayers/master' into vector-api 2013-12-05 16:53:04 +01:00
Tom Payne
600cb3a0ff Add @struct annotation where possible 2013-12-04 16:07:39 +01:00
Tom Payne
0d3583bd8d Improve type checking in WebGL support test 2013-12-04 11:59:29 +01:00
Tom Payne
d6dc1a2c6f Don't use WebGL if there is a major performance caveat 2013-12-04 11:58:05 +01:00
Éric Lemoine
ff66a60e5e Export ol.webgl.Context
It's used in the layer-clipping-webgl example
2013-11-21 23:04:37 +01:00
Tom Payne
26fa8d9d53 Track current program in context, rather than renderers 2013-11-20 11:31:20 +01:00
Tom Payne
10c41cd064 Factor out ol.webgl.Context 2013-11-20 11:31:19 +01:00
Frederic Junod
ca5960666d Be more strict with {Element} types 2013-11-12 13:53:37 +01:00
Éric Lemoine
5c5fcb7e06 Use @exportSymbol for exporting ol.webgl.SUPPORTED
For consistency with the way we export ol.DeviceOrientation.SUPPORTED and ol.Geolocation.SUPPORTED.
2013-09-28 22:47:25 +02:00
Frederic Junod
d061994842 Remove webgl-experimental from ol.webgl.CONTEXT_IDS_ 2013-09-23 14:18:30 +02:00
Frederic Junod
c7b5bd0b6d Add 'experimental-webgl' to ol.webgl.CONTEXT_IDS_ (IE11 support)
see: http://msdn.microsoft.com/en-us/library/ie/ff975238(v=vs.85).aspx
2013-09-23 09:38:45 +02:00
Tim Schaub
54738e29eb Export ol.webgl.SUPPORTED and provide ol.webgl 2013-09-15 15:51:17 -06:00
Frederic Junod
393566155d Export ol.*.SUPPORTED symbols 2013-09-06 22:34:32 +02:00
Tom Payne
14da0cfd11 Don't escape HTML characters in shader generation
This tells Mustache not to escape <, >, &, and " characters.
2013-04-29 11:18:49 +02:00
Tom Payne
667f3de6d9 Remove unused constants 2013-04-08 16:40:53 +02:00
Tom Payne
aa5ce41cb5 Automatically generate uniform and attribute locations 2013-04-08 16:40:49 +02:00
Tom Payne
c6cd3e0227 Refactor glsl-unit templates
This abuses the template system to allow both a single anonymous shader
and multiple named shaders to be defined in a namespace.
2013-04-08 15:57:26 +02:00
Tom Payne
4be8c991f7 Add missing Closure Library requires 2013-04-06 14:28:12 +02:00
Tom Payne
69d06a6e18 Add comment about automatically generated files 2013-03-25 10:04:32 +01:00
Tom Payne
3a4ef83e79 Tidy up ol.webgl namespace 2013-03-24 15:51:09 +01:00
Tom Payne
731fcd3d17 Move shader support code into ol.webgl 2013-03-23 18:29:26 +01:00
Jeff Williams
97879a3572 remove descriptions from JSDoc type tags 2013-03-21 09:54:52 -07:00
Frederic Junod
7e3dcf36a0 Rename ol.*.isSupported function to ol.*.SUPPORTED const 2013-02-19 16:14:37 +01:00
Tom Payne
a82e523f6b Try multiple context ids to get a WebGL context 2012-10-17 17:36:07 +02:00
Tom Payne
5011123228 Use ol.webgl.getContext is WebGL support test 2012-10-17 17:27:11 +02:00
Tom Payne
8cb28a7217 Move WebGL support test into ol.webgl 2012-10-17 17:25:37 +02:00
Tom Payne
1d40b64db1 Move WebGL context creation into ol.webgl 2012-10-17 17:23:30 +02:00
Tom Payne
f8c31ba45c s/ol3/ol/ 2012-09-24 14:21:41 +02:00