Commit Graph

19 Commits

Author SHA1 Message Date
Paul Spencer
4e657e464c Add @todo observable documentation for observable properties
This PR adds documentation for observable properties, which will then be pulled into the docs correctly once #1180 is merged.  This is a first pass based on searching for definition of observable properties being defined as enums after lines ending with `Property = {`.  If there are observable properties implemented that don't follow this pattern then they are not included.

I've added simple descriptions based on what I know or could easily figure out, there may be some properties (like preload) that are not correctly described.

I've also added `readonly` annotations where I knew that a property was readonly.  I may have missed some readonly properties.

ol.layer.Base has a bunch of properties but I don't think it is exported so the documentation of these properties will not show up, so I added the documentation to ol.layer.Layer instead even though this isn't really where it should be documented.
2013-10-29 10:24:54 -04:00
Paul Spencer
bada596b45 Add default stability level to docs of exported things. 2013-10-24 18:20:24 -04:00
Éric Lemoine
925b5d285a Fix export for ol.DeviceOrientation.SUPPORTED 2013-09-28 22:44:59 +02:00
Frederic Junod
4666f64673 Use goog.global instead of window
See f1f319d6ad
2013-09-19 15:03:17 +02:00
Tim Schaub
589c6f8a0b Export ol.DeviceOrientation.SUPPORTED and provide ol.DeviceOrientation 2013-09-15 15:54:41 -06:00
Paul Spencer
4117a5df2d check iOS compass calibration via webkitCompassAccuracy
Ensure that webkitCompassAccuracy is not -1 as this indicates that the
compass has not been calibrated and its values cannot be trusted.
2013-09-09 08:05:37 -04:00
Paul Spencer
69872c99d2 Detect iOS compass heading
iOS webkit does not provide an absolute alpha, instead it provides
webkitCompassHeading.
2013-09-07 21:48:49 -04:00
Paul Spencer
a0ca05d18e Use markdown format for inline links 2013-09-05 09:01:49 -04:00
Paul Spencer
74158e52be Update based on comments
This removes @class and fixes the return type pattern to match the
project standard.  There are a couple of minor changes to the text as
well.
2013-09-05 07:57:16 -04:00
Paul Spencer
f9ba90f4ca More comprehensive docs for ol.DeviceOrientation
Adding an extended class description of DeviceOrientation along with
some additional details in the property accessors.
2013-09-04 21:28:59 -04:00
Tom Payne
b6319c9a68 Use goog.events.Key 2013-07-22 17:42:47 +02:00
Frederic Junod
9cac8a92df Set default 'tracking' property to false 2013-06-21 09:21:48 +02:00
Frederic Junod
c4ce85c847 Add missing 'undefined' in type cast 2013-06-21 09:14:41 +02:00
Frederic Junod
4d4a654a8e Export ol.DeviceOrientation.SUPPORTED 2013-06-08 09:53:06 +02:00
Frederic Junod
9b00967df0 Replace 'changed' with 'change' (see #694) 2013-06-07 16:16:02 +02:00
Frederic Junod
b66b0be8b4 Add options to ol.DeviceOrientation constructor 2013-06-07 16:16:02 +02:00
Frederic Junod
15e5242611 Add 'heading' property to ol.DeviceOrientation 2013-06-07 16:16:02 +02:00
Frederic Junod
c431cc7f63 Add 'tracking' property to ol.DeviceOrientation 2013-06-07 16:16:02 +02:00
Frederic Junod
448e300a03 Add ol.DeviceOrientation 2013-06-07 16:16:02 +02:00