Commit Graph

14 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
34e75b3d9d Add @struct annotation to ol.TileCoord class 2014-01-08 11:48:15 +01:00
Tom Payne
a8d9dad552 Merge pull request #1036 from twpayne/async-tile-load
Asynchronos tile URL calculation
2013-09-20 02:23:09 -07:00
Frederic Junod
e30d0fefb0 Concatenate keys instead of joining it
For performances reasons, see http://jsperf.com/array-join-string-concat
2013-09-18 17:19:50 +02:00
Tom Payne
8ea6a50f03 Add ol.TileCoord#getZXY 2013-09-18 15:37:45 +01:00
Tom Payne
7b58685462 Add ol.TileCoord.createOrUpdate 2013-04-09 19:19:11 +02:00
Tom Payne
02196c94b5 Redefine ol.Coordinate to be Array.<number> 2013-04-05 12:30:37 +02:00
Tom Payne
dfb631a08f Replace getTile with getTileZXY
This massively reduces the number of temporary ol.TileCoord objects.

Previously an ol.TileCoord object was generated for every potentially
visible tile at the current zoom level and lower, every frame.  This
commit eliminates all of those.  Now new ol.TileCoord objects are only
allocated when a new tile is created.
2013-03-24 15:24:49 +01:00
Jeff Williams
97879a3572 remove descriptions from JSDoc type tags 2013-03-21 09:54:52 -07:00
augustus
f253c1bcf8 Some comments (no changes to code) 2012-11-09 16:26:59 +01:00
Tom Payne
424dbd7582 Remove problematic (and unused) clone methods, move contains out of ol.Rectangle 2012-09-25 00:04:45 +02:00
Tom Payne
f8c31ba45c s/ol3/ol/ 2012-09-24 14:21:41 +02:00