Commit Graph

556 Commits

Author SHA1 Message Date
Andreas Hocevar 547334e211 Move oli.* stability notes to the corresponding ol.* symbol 2014-05-22 16:01:35 +02:00
Andreas Hocevar eb6a938062 Do not document object literals as interfaces
Instead, object literals with properties that should not be
renamed can go in externs/olx.js.
2014-05-22 15:48:47 +02:00
Frederic Junod 2f918ea2a4 Remove unused goog.require 2014-05-21 16:06:32 +02:00
Andreas Hocevar b2805c58de Better document which events are fired
The map does not fire ol.render.Event#render. Change events are
now only listed for classes that fire them, and a description
about when they are fired is added.
2014-05-15 20:28:09 +02:00
Andreas Hocevar 0d10314d4f Make sure that ol.source.wms.ServerType is documented 2014-05-15 17:06:19 +02:00
Bart van den Eijnden 4780d17059 Export readFeatures on FormatVectorSource 2014-05-12 10:37:41 +02:00
Andreas Hocevar be73885e37 Merge pull request #2043 from ahocevar/nicer-api-docs
Nicer API docs
2014-05-07 09:20:22 -05:00
Andreas Hocevar 8ee9f7cb6a Simplify the way we annotate observable properties
We no longer add observable annotations to the constructor.
Instead, we just mark getters (and for read/write properties
also setters) with an observable annotation.
2014-05-03 16:04:25 -04:00
Tim Schaub 015aab8af3 Rename ol.extent.transform to ol.extent.applyTransform
This gives more consistency with ol.proj.applyTransform, allowing us to add a more convenient ol.extent.transform method that takes projection-like arguments.
2014-05-02 10:13:28 -06:00
Tim Schaub 4f9968d106 Rename transform to applyTransform for geometries 2014-05-02 09:27:53 -06:00
Andreas Hocevar 7271b50d5a Simplify fires annotations 2014-05-01 22:17:56 +02:00
Tim Schaub 24498fa9d0 Defines in a namespace that can be required
For consistency, all defines are in the ol namespace.  If they are to be moved to another namespace, they need to be requireable.
2014-04-30 09:14:10 -06:00
Tim Schaub e4e3b2229a Defines in ol namespace defined in ol.js 2014-04-30 08:54:30 -06:00
Tim Schaub cec41c4b0a Add missing requires
Without explicit requires, it is possible that a build would exclude ol.js.
2014-04-30 08:37:52 -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
Frederic Junod 68773941d3 Use goog.array.contains instead of goog.array.indexOf 2014-04-26 08:31:40 +02:00
Bart van den Eijnden 0e6b72f94d Merge pull request #1986 from bartvde/wfs-example
ol.format.WFS has no readProjection method (r=@elemoine)
2014-04-24 21:16:53 +02:00
Bart van den Eijnden 962ddff1c2 Implement readProjection on ol.format.WFS and add WFS JSONP example 2014-04-24 20:58:32 +02:00
Frederic Junod 1d688ad29d Use goog.net.Jsonp instead of goog.net.jsloader 2014-04-22 14:44:55 +02:00
Frédéric Junod 3ffed43834 Merge pull request #1995 from fredj/cleanup
Use ol.extent.getWidth and ol.extent.getHeight
2014-04-18 16:20:56 +02:00
Frederic Junod 663e7af0d2 Use ol.extent.getWidth and ol.extent.getHeight 2014-04-17 15:54:13 +02:00
oterral a277cbf548 Add getSource getter in ol.source.ImageVector 2014-04-17 15:21:11 +02:00
Éric Lemoine 2a0026bed3 Merge pull request #1970 from elemoine/geturls
Add getUrl methods to TileWMS and ImageWMS
2014-04-14 20:47:35 +02:00
Frederic Junod 5248bb7a4b Export ol.source.TileImage 2014-04-10 12:27:53 +02:00
Éric Lemoine ee1b4e08a1 Add ol.source.ImageWMS#getUrl 2014-04-10 09:16:24 +02:00
Éric Lemoine e4c2cf0b63 Add ol.source.TileWMS#getUrls 2014-04-10 09:16:24 +02:00
Frederic Junod bbb3527ac7 Don't use 'this' keyword in tileUrlFunction
See a31ad69ec4
Fixes #1965
2014-04-09 09:00:25 +02:00
Frederic Junod 17ed43d230 Fix coding style
Use `goog.isDef(x) ? x : {}` instead of `x || {}`
2014-04-08 11:40:04 +02:00
Tom Payne c155b70281 Export ol.source.ServerVector#readFeatures 2014-04-03 15:57:44 +02:00
Tom Payne f13debbbc9 Load vector tiles for current resolution 2014-04-03 15:23:24 +02:00
Tom Payne 96b7700d63 Use forEachFeatureInExtentAtResolution in ol.source.ImageVector 2014-04-03 15:23:24 +02:00
Tom Payne 3a8504b799 Add ol.source.Vector#forEachFeatureInExtentAtResolution 2014-04-03 15:12:23 +02:00
Tom Payne 683483f8a4 Add ol.source.TileVector 2014-04-03 15:12:22 +02:00
Tom Payne 4a484a7ad3 Separate out feature reading and feature adding 2014-04-03 15:12:22 +02:00
Tom Payne a31ad69ec4 Make tile URL functions more general 2014-04-03 15:12:22 +02:00
Tim Schaub 86c5a582c7 Rename loadingStrategy to strategy 2014-04-03 15:12:22 +02:00
Tim Schaub ce8d805201 Rename loadingFunction to loader 2014-04-03 15:12:22 +02:00
Tom Payne db1a06ac31 Use a BBOX loading strategy by default 2014-04-03 15:12:22 +02:00
Tom Payne 9e75684823 Replace extentUrlFunction with generic loadingFunction 2014-04-03 15:12:22 +02:00
Tom Payne b8869805a7 Rename ol.loading to ol.loadingstrategy 2014-04-03 15:12:22 +02:00
Tom Payne de4a17b8e2 Rename ol.source.RemoteVector to ServerVector 2014-04-03 15:12:22 +02:00
Tom Payne b24e122d4f Add projection argument when loading features 2014-04-03 15:12:22 +02:00
Tom Payne 50c4961b9f Add ol.source.RemoteVector 2014-04-03 15:08:03 +02:00
Tom Payne 8c984cc8f7 Load features before rendering 2014-04-03 15:08:03 +02:00
Tom Payne b008dd1805 Rename ol.source.FormatVector#loadFeatures to loadFeaturesFromURL 2014-04-03 15:05:55 +02:00
Tom Payne 073f83cd22 Factor out ol.source.FormatVector 2014-04-03 15:05:55 +02:00
Tom Payne 77933d0ab3 Rename ol.source.VectorFile to ol.source.StaticVector 2014-04-03 15:05:55 +02:00
Frederic Junod 55de0a54b9 Add ol.dom.createCanvasContext2D function 2014-04-02 09:37:41 +02:00