Commit Graph

29 Commits

Author SHA1 Message Date
Peter Robins
41d9f0360a Add @classdesc to classes 2014-06-09 12:10:19 -04: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
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
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
88c8783271 Allow ol.source.Source state option to be a string 2014-02-06 22:33:42 +01:00
Tom Payne
9f4a9e788c Use inherited dispatchChangeEvent and getRevision in ol.source.Source 2014-01-21 11:42:29 +01:00
Éric Lemoine
4cd2a75900 Add ol.source.Source#forEachFeatureAtPixel 2014-01-14 12:26:50 +01:00
Frederic Junod
e9db2eefb9 Make ol.source.Source inherit from Observable 2014-01-13 10:57:34 +01:00
Paul Spencer
bada596b45 Add default stability level to docs of exported things. 2013-10-24 18:20:24 -04:00
Tom Payne
167b309242 Replace source ready flag with loading/ready/error enum 2013-09-30 13:30:54 +02:00
Tom Payne
3e8abadf95 Merge pull request #1053 from elemoine/sourceoptions
Use typedef in source code for SourceOptions
2013-09-24 03:03:12 -07:00
Éric Lemoine
b2c336c29e Use typedef in source code for SourceOptions 2013-09-23 17:53:43 +02:00
Tom Payne
bd81e6c9a9 Remove source load events 2013-09-20 13:37:40 +01:00
Tim Schaub
3b20cc7b53 Rename ol.Projection to ol.proj.Projection 2013-09-15 22:01:56 -06:00
Tom Payne
cd0186dde5 Store revision number in sources and update it on changes 2013-09-09 17:00:05 +02:00
Tom Payne
788ac5f41d Add ol.source.Source#dispatchChangeEvent 2013-08-21 12:29:28 +02:00
Tom Payne
46553c719c Rename ol.projection to ol.proj 2013-05-30 18:55:58 +02:00
Tom Payne
a537632199 Be more consistent with source options 2013-04-07 11:44:58 +02:00
Tom Payne
6c90bcc5cd Add logo option to ol.source.Source 2013-04-05 18:11:22 +02:00
Éric Lemoine
f86dfc3212 Remove ol.source.SourceOptions typedef
The ol.source.SourceOptions type is already declared in objectliteral.exports, so it should not be declared in the ol/source/source.js file.
2013-03-15 17:56:14 +01:00
Tom Payne
21d34f1cc8 Rename projection functions for a friendlier API
The following functions are renamed:

getTransform -> getTransformForProjections
getTransformFromCodes -> getTransform
transform -> transformWithProjections
transformWithCodes -> transform

With this change, the faster functions that avoid projection look-up
have longer names and are used internally, whereas the slower but
friendlier short name functions are available for users.
2013-03-07 13:39:40 +01:00
Tom Payne
eaa17758bd Allow strings to be used wherever projections are needed 2013-03-07 13:29:40 +01:00
ahocevar
586f393492 Support tile sources without configured projection
This change adds a lot of flexibility to working with tile
layers: Sources where the server projection or tile grid do not
matter can now be constructed without specifying a projection or
tile grid.

The tileUrlFunction/imageUrlFunction now also creates updated
URLs when the params of the layer change, so things like
mergeNewParams in ol2 will be possible.

A nice side effect of this whole change is that there is no more
duplicated code between tiled and single image WMS layers.

While I was at it, I also fixed a WMS 1.1.1 axis order issue
and incorrect STYLES params (STYLES=& instead of STYLES&).
2013-03-05 00:46:58 +01:00
Tom Payne
b6f856f962 Remove unused goog.requires 2013-01-30 22:48:03 +01:00
Éric Lemoine
d04b2bb2bd Fix typo 2013-01-24 10:28:28 +01:00
Éric Lemoine
d99a0c164e Make functions @protected or @private
This also makes jsdoc3 happy along the way.
2012-09-27 17:56:29 +02:00
Tom Payne
65b8e0f915 Use object literals and use generic tile layer 2012-09-27 12:45:00 +02:00