Commit Graph

84 Commits

Author SHA1 Message Date
Tim Schaub 4cf5ab4620 Use @api annotation instead of @todo api 2014-07-05 15:41:14 -04:00
oterral 0fefd680d4 Make ol.tilegrid.TileGrid#getResolutions method exportable 2014-06-25 08:31:45 +02:00
Peter Robins 41d9f0360a Add @classdesc to classes 2014-06-09 12:10:19 -04:00
Tim Schaub e4e3b2229a Defines in ol namespace defined in ol.js 2014-04-30 08:54:30 -06: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
Bart van den Eijnden 1ada9dfea5 Add export for ol.proj.METERS_PER_UNIT 2014-01-30 11:12:17 +01:00
Tom Payne af8e92c0bf Use opt_this instead of opt_obj in ol.tilegrid.TileGrid 2014-01-15 15:09:31 +01:00
Tom Payne d5c1e53e48 Only support square tiles 2014-01-15 09:45:49 +01:00
Frederic Junod 8c61dbef8a Use ol.TileCoord.createOrUpdate function 2014-01-08 11:38:12 +01:00
Tom Payne d8c81773ca Make options to ol.tilegrid.Zoomify optional 2013-12-16 16:09:15 +01:00
Tom Payne cb2727544a Update ol.tilegrid.Zoomify to use new exports system 2013-12-16 16:08:00 +01:00
scharrier 3fe81e451a Remove extra tiles. 2013-12-16 16:01:13 +01:00
Olivier Terral fe1f98899f Add Zoomify stuff 2013-12-16 16:00:59 +01:00
Tom Payne fbc23499e4 Add @struct annotation for simple classes 2013-12-13 18:59:26 +01:00
Éric Lemoine 7b81bfab5c Change @exportClass to @exportSymbol
sed command used: find src/ol -name '*.exports' -exec sed -ri 's/@exportClass\s+(\S+)\s+(\S+)$/@exportSymbol \1/' \{\} \;
2013-12-12 15:05:52 +01:00
Éric Lemoine 315c42f0a7 Use olx namespace for options types in source code
sed command used: find src/ol -name '*.js' -exec sed -ri 's/\{ol(\.(\w|\.)+Options\=?\})/{olx\1/' \{\} \;
2013-12-12 15:02:03 +01:00
Tom Payne 9cbd8de188 Fix order of arguments to ol.extent.createOrUpdate 2013-11-26 12:02:57 -07:00
Paul Spencer bada596b45 Add default stability level to docs of exported things. 2013-10-24 18:20:24 -04:00
Tim Schaub b524de417b Rename ol.ProjectionUnits to ol.proj.Units 2013-09-15 22:04:51 -06:00
Tim Schaub 3b20cc7b53 Rename ol.Projection to ol.proj.Projection 2013-09-15 22:01:56 -06:00
Tim Schaub e806f51b3d Changing extent structure back to single array: [minX, minY, maxX, maxY]
This means we'll have to have a new structure and new methods for 3D envelopes.
2013-09-15 00:31:32 -06:00
Tim Schaub a670b7979c Tile grid working with new extent structure 2013-09-14 21:11:53 -06:00
Éric Lemoine 4e1012823f Merge pull request #860 from elemoine/exports
Add exports
2013-07-18 04:21:59 -07:00
Frederic Junod ad42496948 Initialize all the items in tileRangeByZ 2013-07-16 15:31:05 +02:00
Éric Lemoine b2fc570328 Export tilegrid.WMTS functions 2013-07-12 10:12:51 +02:00
Éric Lemoine c51265502d Export TileGrid functions 2013-07-12 10:12:30 +02:00
Éric Lemoine 2974c74f1a Export ol.tilegrid.TileGrid#getResolutions 2013-06-27 22:37:27 +02:00
Éric Lemoine a19cb9ca64 Sort matrixIds by scaleDenominator
We cannot assume that the matrixIds are ordered in the matrixSet. For example, they're not ordered in http://wxs.ign.fr/cle/geoportail/wmts?SERVICE=WMTS&REQUEST=GetCapabilities.
2013-06-27 21:36:14 +02:00
Éric Lemoine 020d528e73 Tile has a child if z < maxZoom 2013-06-26 07:18:59 +02:00
ahocevar a14b21d80c Use ol.Projection#.getMetersPerUnit()
As a follow-up to #815, this change makes
ol.tilegrid.createForProjection work in cases where a Proj4
projection does not have units set. For better code readability,
a new variable is used when calculating the resolution.
2013-06-25 00:29:50 +02:00
ahocevar 37b369e0d7 Making extent optional for projections
The projection validity extent is used to generate a sensible
set of default resolutions and a sensible default tile grid.
By making it optional, we can still generate defaults - with
zoom levels that are similar to the default web mercator zoom
levels (based on fitting the world on a single tile, even if the
projection is not available for the whole world).
2013-06-17 15:24:37 +02:00
Frederic Junod a1a7e21f92 Redefine ol.Size to be Array.<number> 2013-06-01 10:22:06 +02:00
Tom Payne 46553c719c Rename ol.projection to ol.proj 2013-05-30 18:55:58 +02:00
Tom Payne 09d245c54b Promote createTileCoordTransform into base class 2013-04-30 11:01:57 +02:00
Tom Payne 7a8d29f5e0 Clip tiles to extent in tile coordinate space 2013-04-30 10:30:50 +02:00
Tom Payne 6976fd96e3 Refactor tile functions
* Add support for minZoom in XYZ tile grids and tile sources
* Factor out common tile coordinate transforms
2013-04-29 19:54:26 +02:00
Tom Payne ee2e448220 Remove ol.tilegrid.TileGrid#getPixelBoundsForTileCoordAndResolution 2013-04-22 10:11:13 +02:00
Tom Payne ca8647c808 Port ol.tilegrid to new extents 2013-04-19 09:32:12 +02:00
Tom Payne 0da8b0ae7f Don't inherit ol.PixelBounds from ol.Rectangle 2013-04-19 09:32:11 +02:00
Tom Payne 1ad7765f2f Don't derive ol.TileRange from ol.Rectangle 2013-04-19 09:32:11 +02:00
Tom Payne 680b31c5e0 Eliminate an ol.TileCoord allocation 2013-04-09 19:54:15 +02:00
Tom Payne ee8e565be2 Enable ol.Extent re-use 2013-04-09 19:19:45 +02:00
Tom Payne e30109913e Enable ol.TileRange re-use 2013-04-09 19:19:20 +02:00
Tom Payne 5bd67e1325 Re-use ol.TileCoord objects 2013-04-09 19:19:11 +02:00
Tom Payne 5a4033db7a Enable ol.TileCoord re-use 2013-04-09 19:19:11 +02:00
Tom Payne e732a67382 Propagate return value 2013-04-09 13:15:16 +02:00
Tom Payne 66f0e0d8e8 Add optimized version of getTileCoordChildTileRange for ol.tilegrid.XYZ 2013-04-09 13:15:16 +02:00
Tom Payne c5748f1fd7 Store maxZoom in ol.tilegrid.XYZ 2013-04-09 13:15:16 +02:00