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
ahocevar 2cb045b0b3 Better documentation for the singleclick condition 2014-04-04 14:05:19 +02:00
Tom Payne 29d1ee5e03 Add ol.events.condition.never 2014-03-17 16:40:38 +01:00
tsauerwein c593add6d8 base dragrotateinteraction on pointer interaction 2014-03-14 10:16:26 +01:00
Bart van den Eijnden 87d651af04 Add documentation for API typedef functions 2014-02-14 15:32:12 +01:00
Tom Payne a0d79fe98c Improve type checking in ol.events.condition.targetNotEditable 2014-01-30 11:20:58 +01:00
Éric Lemoine 8402eee0c3 Map "click" event renamed to "singleclick"
As discussed with @tschaub in #1195.
2013-10-31 09:37:16 +01:00
Éric Lemoine 2c930d74b5 clickOnly condition checks map clicks 2013-10-30 13:17:12 +01:00
Frederic Junod a9159ecac3 Rename ol.interaction.condition to ol.events.condition 2013-10-30 12:13:44 +01:00
Tom Payne 5c76291b74 Remove move dead code 2012-09-19 17:04:12 +02:00
ahocevar 8183164298 The underlying event will be needed frequently.
But there will also be events that don't have an underlying event, so we make it optional.
2012-07-12 23:47:16 +02:00
ahocevar 1ad915b428 Shuffling resources; better variable names; better type declarations. 2012-07-12 13:43:47 +02:00