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.
This commit is contained in:
Paul Spencer
2013-10-27 21:03:04 -04:00
parent 9ada23a08a
commit 4e657e464c
12 changed files with 65 additions and 0 deletions

View File

@@ -47,6 +47,23 @@ ol.GeolocationProperty = {
* @extends {ol.Object}
* @param {ol.GeolocationOptions=} opt_options Options.
* @todo stability experimental
* @todo observable accuracy {number} readonly the accuracy of the position
* measurement
* @todo observable altitude {number} readonly the altitude of the position in
* meters above mean sea level
* @todo observable altitudeAccuracy {number} readonly the accuracy of the
* altitude measurement
* @todo observable heading {number} readonly the heading of the device in
* radians from norht
* @todo observable position {ol.Coordinate} readonly the current position of
* the device reported in the current projection
* @todo observable projection {ol.proj.Projection} readonly the projection to
* report the position in
* @todo observable speed {number} readonly the instantaneous speed of the
* device in meters per second
* @todo observable tracking {number} track the device's position.
* @todo observable trackingOptions {number} PositionOptions as defined by the
* HTML5 Geolocation spec at http://dev.w3.org/geo/api/spec-source.html
*/
ol.Geolocation = function(opt_options) {