Commit Graph

28 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
Frederic Junod
756f407ef4 Add file propery to ol.interaction.DragAndDropEvent 2014-04-14 10:47:57 +02:00
Tim Schaub
966317489e Merge pull request #1951 from tschaub/gjslint
Externs lint.
2014-04-04 10:11:34 -06:00
Tim Schaub
fe60d07ef0 Externs lint 2014-04-04 09:28:36 -06:00
Tim Schaub
78324fb54b Remove layers array from frame state 2014-04-04 07:36:42 -06:00
Tim Schaub
aa3a20e911 Provide layer states array in frame state 2014-04-04 07:36:42 -06:00
ahocevar
a3b5376520 Add missing event documentation and stability tags 2014-03-26 14:04:58 +01:00
Éric Lemoine
c4b654b26c Rename skippedFeaturesHash to skippedFeatureUids 2014-03-20 13:29:30 +01:00
Éric Lemoine
435e5e6916 Better type checking in ol.Map 2014-03-20 13:19:54 +01:00
Antoine Abt
78039aceb8 Use a hash to store features uids 2014-03-20 13:03:31 +01:00
Antoine Abt
e1e4969599 Name frameState skippedFeaturesIds as private 2014-03-20 10:24:39 +01:00
Antoine Abt
0d87516135 Map stores skippedFeatures instead of layers 2014-03-19 17:24:58 +01:00
Tom Payne
0a3ef09c30 Add oli.View2DState extern 2014-03-10 17:19:11 +01:00
Tom Payne
8aca7ce140 Add oli.FrameState extern 2014-03-10 14:45:49 +01:00
Tom Payne
b2aa9bb19f Export ol.DragBoxEvent coordinate as a property, not a function 2014-03-02 12:24:09 +01:00
Tom Payne
09d5d31fc7 Rename ol.render.IRender to ol.render.IVectorContext 2014-02-06 18:03:27 +01:00
Tom Payne
318fc68159 Convert ol.MapBrowserEvent#get* methods into properties 2014-01-29 14:51:27 +01:00
Tom Payne
390b61762e Convert ol.DrawEvent#getFeature method into feature property 2014-01-27 15:54:00 +01:00
Tom Payne
ec81a77cdb Convert ol.source.VectorEvent#getFeature method into feature property 2014-01-27 15:54:00 +01:00
Tom Payne
df0912bdd3 Convert ol.render.Event#get* methods into properties 2014-01-27 15:54:00 +01:00
Tom Payne
37351c530c Convert ol.ObjectEvent#getKey method into key property 2014-01-27 15:53:58 +01:00
Tom Payne
45350a34ed Convert ol.interaction.DragAndDropEvent#get* methods into properties 2014-01-27 15:52:03 +01:00
Tom Payne
3d68a3550e Convert ol.CollectionEvent#getElement method into element property 2014-01-27 15:52:03 +01:00
Éric Lemoine
96ef1ed3bd Remove handleMapPostrender extension point 2013-08-31 23:25:08 +02:00
Éric Lemoine
124b195d3e handleMapPostrender returns undefined
Without this we get the following warning from the compiler:

JSC_EXPORTED_FUNCTION_UNKNOWN_RETURN_TYPE. Unable to determine return type for exported function ol.control.Control.prototype.handleMapPostrender at ../src/ol/control/control.js line 79 : 51

I'm not sure why explicitely specifying the return type is required here.
2013-05-10 14:04:50 +02:00
Éric Lemoine
88352092ee Externalize Control.handleMapPostrender 2013-05-10 10:45:24 +02:00
Éric Lemoine
7a71f107cb Export and externalize Control.setMap 2013-05-10 10:24:11 +02:00